Skip to content
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

[Request]: Update APM docs to reflect changes related to the Elasticsearch apm-data plugin #4313

Closed
colleenmcginnis opened this issue Sep 27, 2024 · 0 comments · Fixed by #4333

Comments

@colleenmcginnis
Copy link
Contributor

Description

In 8.15, the APM team moved index templates, component templates, and ingest pipelines from the APM integration package to a new Elasticsearch apm-data plugin. The APM integration package is now an input-only package meaning that the package would not define any data streams.

Here's my understanding of how this will impact the docs (please correct me if I'm wrong!):

  • 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 the APM integration was providing is now built into Elasticsearch (i.e. the apm-data plugin).
  • 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.
  • 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.
  • In addition to updates in the Observability guide, the integration docs probably also need to be updated.

My next step is to go through individual docs to determine which need to be updated based on these principles ☝ and open a draft PR for the APM team to review.

Resources

Here's what I've found:

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

@simitt can you confirm that this works the same way in stateful and serverless?

What release is this request related to?

8.15

Collaboration model

The documentation team

Point of contact.

Main contact: @carsonip? (feel free to tag others as needed)

Stakeholders: TBD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant