Skip to content

docs: Update "Advanced Setup" section#10791

Merged
kruskall merged 8 commits intoelastic:mainfrom
bmorelli25:ft-advanced-setup
May 16, 2023
Merged

docs: Update "Advanced Setup" section#10791
kruskall merged 8 commits intoelastic:mainfrom
bmorelli25:ft-advanced-setup

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented May 11, 2023

Summary

This PR...

  • renames the "Set up" section to "Advanced setup"
  • Adds links to the Fleet and Agent guide where applicable.
  • Deletes one of the duplicated "Tune Elasticsearch" pages
  • Moves "Tune APM Server into the "Advanced setup" topic
  • Adds Agent content to the "Tune..." documentation where applicable
  • Removes Keystore documentation

PREVIEW ME: https://apm-server_10791.docs-preview.app.elstc.co/guide/en/apm/guide/master/setting-up-and-running.html

@bmorelli25 bmorelli25 requested a review from a team May 11, 2023 02:00
@bmorelli25 bmorelli25 self-assigned this May 11, 2023
@mergify
Copy link
Contributor

mergify bot commented May 11, 2023

This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.x is the label to automatically backport to the 7.x branch.
  • backport-7./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label May 11, 2023
@ghost
Copy link

ghost commented May 11, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-05-16T15:40:51.905+0000

  • Duration: 9 min 51 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate and publish the docker images.

  • /test windows : Build & tests on Windows.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@bmorelli25 bmorelli25 marked this pull request as ready for review May 11, 2023 02:43
@mergify
Copy link
Contributor

mergify bot commented May 15, 2023

This pull request is now in conflicts. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b ft-advanced-setup upstream/ft-advanced-setup
git merge upstream/main
git push upstream ft-advanced-setup

@bmorelli25 bmorelli25 requested a review from a team May 16, 2023 01:03
@ghost
Copy link

ghost commented May 16, 2023

📚 Go benchmark report

Diff with the main branch

goos: linux
goarch: amd64
pkg: github.com/elastic/apm-server/internal/agentcfg
cpu: 12th Gen Intel(R) Core(TM) i5-12500
                                  │ build/main/bench.out │              bench.out              │
                                  │        sec/op        │    sec/op     vs base               │
FetchAndAdd/FetchFromCache-12                41.17n ± 0%    46.21n ± 1%  +12.24% (p=0.002 n=6)
FetchAndAdd/FetchAndAddToCache-12            93.01n ± 3%   102.80n ± 9%  +10.53% (p=0.002 n=6)
geomean                                      61.88n         68.93n       +11.38%

                                  │ build/main/bench.out │             bench.out              │
                                  │         B/op         │    B/op     vs base                │
geomean                                                ²               +0.00%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

                                  │ build/main/bench.out │             bench.out              │
                                  │      allocs/op       │ allocs/op   vs base                │
geomean                                                ²               +0.00%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

pkg: github.com/elastic/apm-server/internal/beater/request
                                             │ build/main/bench.out │              bench.out              │
                                             │        sec/op        │    sec/op     vs base               │
ContextReset/X-Forwarded-For_ipv4-12                   937.1n ± 25%   666.1n ± 28%  -28.92% (p=0.026 n=6)
ContextResetContentEncoding/empty-12                   116.3n ±  2%   131.2n ±  1%  +12.81% (p=0.002 n=6)
ContextResetContentEncoding/uncompressed-12            140.7n ±  1%   157.5n ±  1%  +11.94% (p=0.002 n=6)
geomean                                                907.2n         922.5n         +1.68%

                                             │ build/main/bench.out │              bench.out               │
                                             │         B/op         │     B/op      vs base                │
geomean                                                           ²                 +0.00%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

                                             │ build/main/bench.out │             bench.out              │
                                             │      allocs/op       │ allocs/op   vs base                │
geomean                                                           ²               +0.00%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

pkg: github.com/elastic/apm-server/internal/publish
             │ build/main/bench.out │          bench.out          │
             │        sec/op        │   sec/op    vs base         │

             │ build/main/bench.out │           bench.out            │
             │         B/op         │     B/op       vs base         │

             │ build/main/bench.out │           bench.out           │
             │      allocs/op       │  allocs/op    vs base         │

pkg: github.com/elastic/apm-server/x-pack/apm-server/aggregation/spanmetrics
                 │ build/main/bench.out │           bench.out           │
                 │        sec/op        │    sec/op     vs base         │

                 │ build/main/bench.out │            bench.out            │
                 │         B/op         │     B/op      vs base           │
¹ all samples are equal

                 │ build/main/bench.out │           bench.out           │
                 │      allocs/op       │ allocs/op   vs base           │
¹ all samples are equal

pkg: github.com/elastic/apm-server/x-pack/apm-server/aggregation/txmetrics
                        │ build/main/bench.out │          bench.out           │
                        │        sec/op        │   sec/op     vs base         │

                        │ build/main/bench.out │           bench.out           │
                        │         B/op         │    B/op     vs base           │
¹ all samples are equal

                        │ build/main/bench.out │           bench.out           │
                        │      allocs/op       │ allocs/op   vs base           │
¹ all samples are equal

pkg: github.com/elastic/apm-server/x-pack/apm-server/sampling
               │ build/main/bench.out │             bench.out              │
               │        sec/op        │    sec/op     vs base              │
geomean                  628.4n         618.4n        -1.59%

               │ build/main/bench.out │              bench.out               │
               │         B/op         │     B/op      vs base                │
geomean                             ²                 -0.12%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

               │ build/main/bench.out │             bench.out              │
               │      allocs/op       │ allocs/op   vs base                │
geomean                             ²               +0.00%               ²
¹ all samples are equal
² summaries must be >0 to compute geomean

pkg: github.com/elastic/apm-server/x-pack/apm-server/sampling/eventstorage
                                            │ build/main/bench.out │               bench.out               │
                                            │        sec/op        │    sec/op      vs base                │
WriteTransaction/json_codec-12                        4.282µ ± 28%    9.893µ ± 90%  +131.04% (p=0.009 n=6)
WriteTransaction/json_codec_big_tx-12                 5.025µ ±  4%   11.060µ ± 45%  +120.09% (p=0.002 n=6)
ReadEvents/json_codec/0_events-12                     309.2n ± 10%    346.1n ± 14%   +11.92% (p=0.009 n=6)
ReadEvents/json_codec/1_events-12                     10.35µ ±  6%    11.04µ ±  4%    +6.67% (p=0.041 n=6)
ReadEvents/json_codec_big_tx/0_events-12              302.2n ±  5%    351.9n ±  7%   +16.45% (p=0.002 n=6)
ReadEvents/json_codec_big_tx/1_events-12              11.70µ ±  3%    12.81µ ±  8%    +9.48% (p=0.009 n=6)
ReadEvents/nop_codec/0_events-12                      309.4n ±  6%    356.5n ±  7%   +15.24% (p=0.002 n=6)
ReadEvents/nop_codec_big_tx/0_events-12               312.4n ±  7%    343.1n ±  7%    +9.84% (p=0.002 n=6)
ReadEvents/nop_codec_big_tx/1_events-12               1.990µ ±  9%    2.164µ ± 34%    +8.72% (p=0.041 n=6)
ReadEvents/nop_codec_big_tx/100_events-12             150.2µ ± 13%    141.1µ ± 11%    -6.06% (p=0.041 n=6)
IsTraceSampled/sampled-12                             70.09n ±  4%    77.87n ±  5%   +11.09% (p=0.002 n=6)
IsTraceSampled/unsampled-12                           71.52n ±  1%    79.57n ±  1%   +11.26% (p=0.002 n=6)
IsTraceSampled/unknown-12                             372.2n ±  6%    413.4n ±  6%   +11.05% (p=0.002 n=6)
geomean                                               29.37µ          30.78µ          +4.80%

                                            │ build/main/bench.out │               bench.out                │
                                            │         B/op         │      B/op       vs base                │
WriteTransaction/json_codec_big_tx-12                3.686Ki ±  0%    3.688Ki ±  0%  +0.04% (p=0.022 n=6)
ReadEvents/nop_codec_big_tx/1_events-12              3.194Ki ±  0%    3.191Ki ±  0%  -0.09% (p=0.009 n=6)
ReadEvents/nop_codec_big_tx/100_events-12            244.7Ki ±  0%    244.6Ki ±  0%  -0.05% (p=0.026 n=6)
geomean                                              31.42Ki          31.39Ki        -0.11%
¹ all samples are equal

                                            │ build/main/bench.out │              bench.out              │
                                            │      allocs/op       │  allocs/op   vs base                │
geomean                                                 144.7         144.7       -0.00%
¹ all samples are equal

report generated with https://pkg.go.dev/golang.org/x/perf/cmd/benchstat

See <<keystore>> for more examples.

endif::[]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not blocking this PR, but let's have a conversation around how to document the commands for the apm-server binary before releasing the new docs (including why/if to remove the keystore docs);

@kruskall kruskall merged commit 9698daa into elastic:main May 16, 2023
@bmorelli25 bmorelli25 deleted the ft-advanced-setup branch May 16, 2023 16:08
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request May 23, 2023
* remove keystore

* add advanced setup

# Conflicts:
#	docs/integrations-index.asciidoc

* couple more keystore things

* finish advanced setup

* feedback from @simitt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-skip Skip notification from the automated backport with mergify docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants