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

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

Merged
merged 19 commits into from
Oct 23, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Oct 1, 2024

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

  • Initial updates
    • Search APM +\n?integration
    • Search data *\n?streams?
    • Search index +\n?templates?
    • Search index +\n?mappings?
    • Search ILM +\n?polic(y|ies)
    • Search ingest +\n?pipelines?
  • Decide if it should be "Elasticsearch APM data plugin" or "Elasticsearch apm-data plugin" and then make sure we're using one phrase consistently
  • Product/Engineering Review
  • Writer Review

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:

@colleenmcginnis 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 colleenmcginnis self-assigned this Oct 1, 2024
Copy link
Contributor

github-actions bot commented Oct 1, 2024

A documentation preview will be available soon.

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.

@colleenmcginnis 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
docs/en/observability/apm-ui/troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm-ui/troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/common-problems.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/configure/general.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/data-streams.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/shared-kibana-endpoint.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/upgrading-to-8.x.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

mergify bot commented Oct 7, 2024

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

@colleenmcginnis colleenmcginnis marked this pull request as ready for review October 7, 2024 18:12
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner October 7, 2024 18:12
carsonip
carsonip previously approved these changes Oct 15, 2024
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, 2 nits

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
carsonip
carsonip previously approved these changes Oct 15, 2024
lahsivjar
lahsivjar previously approved these changes Oct 17, 2024
Copy link
Contributor

@lahsivjar lahsivjar left a 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!

@lahsivjar lahsivjar requested a review from axw October 17, 2024 11:12
@lahsivjar
Copy link
Contributor

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

Copy link
Member

@axw axw left a 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.

Copy link
Contributor

@lahsivjar lahsivjar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bmorelli25 bmorelli25 added the backport-8.16 Automated backport with mergify label Oct 22, 2024
@colleenmcginnis colleenmcginnis merged commit 27fc737 into elastic:main Oct 23, 2024
7 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4313 branch October 23, 2024 13:10
mergify bot pushed a commit that referenced this pull request Oct 23, 2024
… 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
mergify bot pushed a commit that referenced this pull request Oct 23, 2024
… 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)
mergify bot pushed a commit that referenced this pull request Oct 23, 2024
… 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)
colleenmcginnis added a commit that referenced this pull request Oct 23, 2024
… 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]>
colleenmcginnis added a commit that referenced this pull request Oct 23, 2024
… 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]>
colleenmcginnis added a commit that referenced this pull request Oct 23, 2024
…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]>
eedugon pushed a commit to eedugon/observability-docs that referenced this pull request Nov 6, 2024
… 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport with mergify backport-8.16 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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