[8.x](backport #4333) [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin#4426
Merged
colleenmcginnis merged 1 commit into8.xfrom Oct 23, 2024
Merged
Conversation
… 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)
Contributor
|
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. |
colleenmcginnis
approved these changes
Oct 23, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-dataplugin) (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-dataplugin, 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-dataplugin 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?integrationdata *\n?streams?index +\n?templates?index +\n?mappings?ILM +\n?polic(y|ies)ingest +\n?pipelines?Follow-up tasks
Select one.
This is an automatic backport of pull request #4333 done by [Mergify](https://mergify.com).