[apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin by colleenmcginnis · Pull Request #4333 · elastic/observability-docs

colleenmcginnis · 2024-10-01T18:09:16Z

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.

Stateful (docs/en/observability/*)
Serverless (docs/en/serverless/*)
Integrations Developer Guide (docs/en/integrations/*)
None of the above

Related issue

Closes #4313

Checklist

Follow-up tasks

Select one.

This PR does not need to be ported to another doc set because:
- The concepts in this PR only apply to one doc set (serverless or stateful)
- The PR contains edits to both doc sets (serverless and stateful)
This PR needs to be ported to another doc set:
- Port to stateful docs: <link to PR or tracking issue>
- Port to serverless docs: https://github.com/elastic/observability-docs/issues/4420

github-actions · 2024-10-01T18:09:29Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{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.}

docs/en/observability/apm-ui/troubleshooting.asciidoc

docs/en/observability/apm/common-problems.asciidoc

docs/en/observability/apm-ui/troubleshooting.asciidoc

docs/en/observability/apm/common-problems.asciidoc

docs/en/observability/apm/configure/general.asciidoc

docs/en/observability/apm/data-streams.asciidoc

docs/en/observability/apm/shared-kibana-endpoint.asciidoc

docs/en/observability/apm/upgrading-to-8.x.asciidoc

mergify · 2024-10-07T13:09:15Z

This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-4313 upstream/issue-4313
git merge upstream/main
git push upstream issue-4313

carsonip

lgtm, 2 nits

docs/en/observability/apm/shared-kibana-endpoint.asciidoc

docs/en/observability/apm/configure/general.asciidoc

lahsivjar

Thanks for this! Just a few minor comments otherwise LGTM!

docs/en/observability/apm/manage-storage/ilm-how-to.asciidoc

lahsivjar · 2024-10-17T11:13:04Z

Adding @axw to take a look in case I missed something.

axw

Looks great, thank you @colleenmcginnis! I just left a couple of minor comments.

lahsivjar

LGTM!

@carsonip

… 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

@carsonip

… 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)

@carsonip

… 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)

@carsonip

… 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 <colleen.mcginnis@elastic.co>

@carsonip

… 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 <colleen.mcginnis@elastic.co>

@carsonip

…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 <colleen.mcginnis@elastic.co>

@carsonip

… 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

Colleen McGinnis added 3 commits October 1, 2024 12:50

update getting started docs

20d8259

update upgrade guide

14b33b3

fix build

5ec6262

colleenmcginnis added backport-8.15 Automated backport with mergify backport-8.x Automated backport to the 8.x branch with mergify labels Oct 1, 2024

colleenmcginnis self-assigned this Oct 1, 2024

Colleen McGinnis added 4 commits October 2, 2024 12:53

audit mentions of the apm integration

ed159f0

audit mentions of data streams

a8d9275

audit mentions of index templates

701c9fc

audit mentions of index mappings

cd5be47

colleenmcginnis commented Oct 4, 2024

View reviewed changes

docs/en/observability/apm-ui/troubleshooting.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/apm/common-problems.asciidoc Outdated Show resolved Hide resolved

colleenmcginnis changed the title ~~[work in progress!] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin~~ [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin Oct 4, 2024

colleenmcginnis requested a review from carsonip October 4, 2024 15:20

colleenmcginnis added the needs-dev-review label Oct 4, 2024

carsonip reviewed Oct 4, 2024

View reviewed changes

Colleen McGinnis added 3 commits October 7, 2024 08:44

Merge branch 'main' into issue-4313

c50dbdd

address feedback from @carsonip

b342801

update diagram

d14869b

colleenmcginnis marked this pull request as ready for review October 7, 2024 18:12

colleenmcginnis requested a review from a team as a code owner October 7, 2024 18:12

colleenmcginnis requested a review from carsonip October 7, 2024 18:13

docs-project-automation bot added the needs-writer-review label Oct 7, 2024

carsonip previously approved these changes Oct 15, 2024

View reviewed changes

docs/en/observability/apm/shared-kibana-endpoint.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/apm/configure/general.asciidoc Outdated Show resolved Hide resolved

Colleen McGinnis added 2 commits October 15, 2024 10:45

Merge branch 'main' into issue-4313

4a0c710

address more feedback from @carsonip

e7529cc

colleenmcginnis dismissed carsonip’s stale review via e7529cc October 15, 2024 16:01

colleenmcginnis removed the needs-dev-review label Oct 15, 2024

carsonip previously approved these changes Oct 15, 2024

View reviewed changes

Colleen McGinnis added 3 commits October 16, 2024 10:50

address more feedback from @lahsivjar

d7ff617

add link

2d1c83f

fix table formatting

26aa8c6

lahsivjar previously approved these changes Oct 17, 2024

View reviewed changes

docs/en/observability/apm/manage-storage/ilm-how-to.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/apm/manage-storage/ilm-how-to.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/apm/manage-storage/ilm-how-to.asciidoc Outdated Show resolved Hide resolved

lahsivjar requested a review from axw October 17, 2024 11:12

lucabelluccini mentioned this pull request Oct 17, 2024

[Docs/RN] APM Package documentation is missing after 8.4.2 + document 8.15.0 changes in integrations page elastic/apm-server#14383

Open

axw reviewed Oct 18, 2024

View reviewed changes

This comment was marked as outdated.

Sign in to view

Merge branch 'main' into issue-4313

f962fc7

colleenmcginnis dismissed lahsivjar’s stale review via f962fc7 October 22, 2024 14:14

address more feedback from @lahsivjar

8f13180

colleenmcginnis requested a review from lahsivjar October 22, 2024 14:44

lahsivjar approved these changes Oct 22, 2024

View reviewed changes

bmorelli25 added the backport-8.16 Automated backport with mergify label Oct 22, 2024

bmorelli25 approved these changes Oct 22, 2024

View reviewed changes

bmorelli25 removed the needs-writer-review label Oct 22, 2024

colleenmcginnis merged commit 27fc737 into elastic:main Oct 23, 2024

colleenmcginnis deleted the issue-4313 branch October 23, 2024 13:10

mergify bot mentioned this pull request Oct 23, 2024

[8.15](backport #4333) [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin #4425

Merged

18 tasks

This was referenced Oct 23, 2024

[8.x](backport #4333) [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin #4426

Merged

[8.16](backport #4333) [apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin #4427

Merged

colleenmcginnis mentioned this pull request Nov 8, 2024

[apm] Port apm-data plugin changes from stateful docs #4507

Merged

10 tasks

Conversation

colleenmcginnis commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Documentation sets edited in this PR

Related issue

Checklist

Follow-up tasks

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mergify bot commented Oct 7, 2024

Uh oh!

carsonip left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lahsivjar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lahsivjar commented Oct 17, 2024

Uh oh!

axw left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

lahsivjar left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

colleenmcginnis commented Oct 1, 2024 •

edited

Loading