-
Notifications
You must be signed in to change notification settings - Fork 164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin #4333
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, 2 nits
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! Just a few minor comments otherwise LGTM!
Adding @axw to take a look in case I missed something. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thank you @colleenmcginnis! I just left a couple of minor comments.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
… apm-data plugin (#4333) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737) # Conflicts: # docs/en/observability/apm-ui/troubleshooting.asciidoc # docs/en/observability/apm/getting-started-apm-server.asciidoc # docs/en/observability/apm/getting-started-apm/get-started-with-fleet-apm-server.asciidoc # docs/en/observability/apm/getting-started-apm/index.asciidoc # docs/en/observability/apm/upgrading-to-8.x.asciidoc
… apm-data plugin (#4333) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737)
… apm-data plugin (#4333) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737)
… apm-data plugin (#4333) (#4426) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737) Co-authored-by: Colleen McGinnis <[email protected]>
… apm-data plugin (#4333) (#4427) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737) Co-authored-by: Colleen McGinnis <[email protected]>
…ed to the Elasticsearch apm-data plugin (#4425) * [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin (#4333) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar (cherry picked from commit 27fc737) # Conflicts: # docs/en/observability/apm-ui/troubleshooting.asciidoc # docs/en/observability/apm/getting-started-apm-server.asciidoc # docs/en/observability/apm/getting-started-apm/get-started-with-fleet-apm-server.asciidoc # docs/en/observability/apm/getting-started-apm/index.asciidoc # docs/en/observability/apm/upgrading-to-8.x.asciidoc * fix conflicts * fix more ia related conflicts --------- Co-authored-by: Colleen McGinnis <[email protected]>
… apm-data plugin (elastic#4333) * update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar
Description
Updates APM docs to reflect changes related to the Elasticsearch apm-data plugin.
Here's my understanding of how this change will impact the docs (please correct me if I'm wrong!):
1️⃣ When a user sets up the APM Server binary, they used to have to install the APM integration. Now users using the APM Server binary shouldn't have to install or work with the APM integration at all because the functionality that the APM integration was providing to the APM Server binary users is now built into Elasticsearch (i.e. the
apm-data
plugin) (if I'm understanding elastic/apm-server#11267 correctly).2️⃣ When a user sets up a Fleet-managed APM Server, how the APM integration works behind the scenes changes with the addition of the Elasticsearch
apm-data
plugin, but the workflow for getting a Fleet-managed APM Server initially set up will not change so the docs on getting set up don't need to be updated.3️⃣ Users using either the APM Server binary or Fleet-managed APM Server will need to know about how the Elasticsearch
apm-data
plugin works and how the APM integration's role has changed if/when they are customizing index templates, component templates, or ingest pipelines.4️⃣ In addition to updates in the Observability guide, the integration docs probably also need to be updated.
Preview: https://observability-docs_bk_4333.docs-preview.app.elstc.co/guide/en/observability/master/apm.html
Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #4313
Checklist
APM +\n?integration
data *\n?streams?
index +\n?templates?
index +\n?mappings?
ILM +\n?polic(y|ies)
ingest +\n?pipelines?
Follow-up tasks
Select one.