Update APM Quick start and new management modes#10750
Conversation
|
This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
NOTE: |
Co-authored-by: Silvia Mitter <silvia.mitter@elastic.co>
…new-apm-start # Conflicts: # docs/apm-components.asciidoc # docs/legacy/configuring-ingest.asciidoc # docs/legacy/sourcemap-api.asciidoc
|
@bmorelli25 please ping me when this is ready for another round of review |
|
Looks good overall. Should we be saying something like "Elastic Agent-managed", rather than "Fleet-managed"? Elastic Agent itself may be in standalone or Fleet mode. Given that we've added support for source maps and agent config in standalone mode, should we generalise a bit here? |
@axw For phase one of our documentation redesign, we decided to level-up the APM Server binary and present two main and equally recommended options for running APM Server: the APM Server binary and Fleet-managed APM Server. Running Elastic Agent standalone (in any capacity) is still an "advanced" use-case with incomplete and less mature documentation. The Elastic Agent team is having active discussions about making standalone easier to use and prioritizing filling our documentation gaps on that topic. As they move in that direction, we will as well. So we'll eventually document three methods of installing/running/etc APM Server. |
…new-apm-start # Conflicts: # docs/integrations-index.asciidoc
|
@elasticmachine, run elasticsearch-ci/docs |
simitt
left a comment
There was a problem hiding this comment.
Is it intended that docs are still placed under the legacy header?
📚 Go benchmark reportDiff with the report generated with https://pkg.go.dev/golang.org/x/perf/cmd/benchstat |
|
This pull request is now in conflicts. Could you fix it @bmorelli25? 🙏 |
…new-apm-start # Conflicts: # docs/integrations-index.asciidoc
simitt
left a comment
There was a problem hiding this comment.
Looks good, just left a couple of smaller comments.
| This should match the host and port defined when setting up the APM integration. | ||
|
|
||
| * **Secret token**: Authentication method for {apm-agent} and APM Server communication. | ||
| This should match the secret token defined when setting up the APM integration. |
There was a problem hiding this comment.
Step 2 mentions to write down the apm-server url as it is needed afterwards, no mentioning of the secret-token. But here the secret token is required. Either we describe to enable api-key auth and make it part of this instructions, or we add the secret-token in Step 2.
There was a problem hiding this comment.
This content lives in the observability-docs repo. I've opened elastic/observability-docs#2964 to add the secret token to step two.
Co-authored-by: Silvia Mitter <silvia.mitter@elastic.co>
* add Elastic Cloud quick start * update self managed quick start * add advanced setup * add decision tree
Summary
This PR separates our getting started content into two sections:
The self-managed get started page includes all new content that explains the difference between using the APM Server binary, and using a Fleet-managed APM Server. Specifically, we call out pros/cons, supported outputs, required components, and the configuration method. There is also a decision tree to help users decide which options is right for them.
Questions for reviewers
APM Server binary | Fleet-managedclear enough?