[8.8] Backport documentation redesign changes #10874

bmorelli25 · 2023-05-23T00:53:27Z

Summary

This PR backports the following PRs to 8.8:

* move all `legacy` content up a level * remove deprecation notices * Delete legacy APM Overview * fix local links # Conflicts: # changelogs/7.15.asciidoc * delete 7.x cl * delete duplicate API section APM Server Reference # Conflicts: # docs/legacy/sourcemap-api.asciidoc * delete legacy souremap-api * fix doc build errors * remove duplicate how to guides from APM Server reference # Conflicts: # docs/legacy/configuring-ingest.asciidoc * combine redirects and clean up index * fix links * feedback * Revert changelog deletion This reverts commit bcc1de4. # Conflicts: # docs/legacy/events-api.asciidoc # docs/legacy/storage-management.asciidoc * Revert "delete 7.x cl" This reverts commit 1ab3973.

This PR removes the exported fields documentation.

This PR is mostly structural. It moves the Configure section up two levels in the navigation. This requires many heading-level changes. I also moved all of the configure documentation to a new subdirectory so it's easier to find and edit. Separating this into its own PR should make the content changes that are coming easier to review. # Conflicts: # docs/configure/general.asciidoc

@simitt

* remove keystore * add advanced setup # Conflicts: # docs/integrations-index.asciidoc * couple more keystore things * finish advanced setup * feedback from @simitt

* exploring-es-data * remove leftover comment * fix doc build

@simitt

* monitoring docs * feedback from @simitt

@simitt

* very basic for now * update and combine troubleshooting guides * remove file * empty * fix broken link * feedback from @simitt * Apply suggestions from code review Co-authored-by: Andrew Wilkins <[email protected]> --------- Co-authored-by: Andrew Wilkins <[email protected]>

@simitt

* rest of secure docs * per @simitt, remove addtl users and roles * remove linux seccomp

* add Elastic Cloud quick start * update self managed quick start * add advanced setup * add decision tree

# Conflicts: # docs/apm-input-settings.asciidoc # docs/configure/agent-config.asciidoc # docs/configure/rum.asciidoc

apmmachine · 2023-05-23T00:59:50Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-05-23T00:53:42.846+0000
Duration: 6 min 3 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!)

apmmachine · 2023-05-23T00:59:54Z

📚 Go benchmark report

Diff with the 8.8 branch

goos: linux
goarch: amd64
pkg: github.com/elastic/apm-server/internal/agentcfg
cpu: 12th Gen Intel(R) Core(TM) i5-12500
                                  │ build/8.8/bench.out │             bench.out             │
                                  │       sec/op        │   sec/op     vs base              │
geomean                                     68.31n        68.34n       +0.04%

                                  │ build/8.8/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/8.8/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/8.8/bench.out │             bench.out              │
                                             │       sec/op        │    sec/op     vs base              │
geomean                                               915.9n         904.5n        -1.25%

                                             │ build/8.8/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/8.8/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/8.8/bench.out │          bench.out          │
             │       sec/op        │   sec/op    vs base         │

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

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

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

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

                 │ build/8.8/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/8.8/bench.out │          bench.out           │
                        │       sec/op        │   sec/op     vs base         │

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

                        │ build/8.8/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/8.8/bench.out │             bench.out              │
               │       sec/op        │    sec/op     vs base              │
geomean                 623.4n         617.3n        -0.99%

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

               │ build/8.8/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/8.8/bench.out │             bench.out              │
                                            │       sec/op        │    sec/op     vs base              │
ReadEvents/json_codec_big_tx/100_events-12           1.008m ±  4%   1.029m ±  2%  +2.12% (p=0.041 n=6)
ReadEvents/nop_codec/399_events-12                   462.5µ ±  4%   487.3µ ± 12%  +5.36% (p=0.041 n=6)
IsTraceSampled/unsampled-12                          78.73n ±  3%   77.70n ±  1%  -1.31% (p=0.009 n=6)
geomean                                              31.90µ         32.63µ        +2.31%

                                            │ build/8.8/bench.out │               bench.out                │
                                            │        B/op         │      B/op       vs base                │
ReadEvents/json_codec_big_tx/10_events-12           100.9Ki ±  0%    100.9Ki ±  0%  -0.04% (p=0.006 n=6)
ReadEvents/json_codec_big_tx/399_events-12          2.115Mi ±  0%    2.120Mi ±  0%  +0.26% (p=0.037 n=6)
ReadEvents/nop_codec_big_tx/199_events-12           458.9Ki ±  0%    459.7Ki ±  0%  +0.17% (p=0.009 n=6)
geomean                                             31.44Ki          31.39Ki        -0.18%
¹ all samples are equal

                                            │ build/8.8/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

simitt

Thanks for this huge refactoring! I believe this is a big improvement and hopefully brings more clarity into when & how to use the apm-server binary vs. Fleet managed

bmorelli25 and others added 11 commits May 22, 2023 14:21

docs: remove exported fields (elastic#10772)

e220e91

This PR removes the exported fields documentation.

docs: Update "Advanced Setup" section (elastic#10791)

5def2bc

* remove keystore * add advanced setup # Conflicts: # docs/integrations-index.asciidoc * couple more keystore things * finish advanced setup * feedback from @simitt

docs: Update exploring data in {es} (elastic#10814)

18bfb05

* exploring-es-data * remove leftover comment * fix doc build

docs: Update monitoring (elastic#10813)

e364e61

* monitoring docs * feedback from @simitt

secure comms with APM agents (elastic#10828)

8f4fb51

docs: Secure communication (elastic#10841)

34706cf

* rest of secure docs * per @simitt, remove addtl users and roles * remove linux seccomp

Update APM Quick start and new management modes (elastic#10750)

892f0e2

* add Elastic Cloud quick start * update self managed quick start * add advanced setup * add decision tree

docs: Update APM Server config (elastic#10842)

6b73efb

# Conflicts: # docs/apm-input-settings.asciidoc # docs/configure/agent-config.asciidoc # docs/configure/rum.asciidoc

bmorelli25 added the backport label May 23, 2023

bmorelli25 requested a review from a team May 23, 2023 00:53

axw approved these changes May 23, 2023

View reviewed changes

simitt approved these changes May 23, 2023

View reviewed changes

simitt merged commit 8c23de7 into elastic:8.8 May 23, 2023

bmorelli25 deleted the 8.8-backport-documentation-changes branch May 23, 2023 16:31

abdonpijpelink mentioned this pull request May 25, 2023

docs: redirects for removed pages #10891

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.8] Backport documentation redesign changes #10874

[8.8] Backport documentation redesign changes #10874

bmorelli25 commented May 23, 2023

apmmachine commented May 23, 2023

Build stats

apmmachine commented May 23, 2023

simitt left a comment

[8.8] Backport documentation redesign changes #10874

[8.8] Backport documentation redesign changes #10874

Conversation

bmorelli25 commented May 23, 2023

Summary

apmmachine commented May 23, 2023

💚 Build Succeeded

Build stats

🤖 GitHub comments

apmmachine commented May 23, 2023

📚 Go benchmark report

simitt left a comment

Choose a reason for hiding this comment