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

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

Merged
merged 3 commits into from
Oct 23, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 23, 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:

This is an automatic backport of pull request #4333 done by [Mergify](https://mergify.com).

… 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 mergify bot requested a review from a team as a code owner October 23, 2024 13:12
@mergify mergify bot added backport conflicts There is a conflict in the backported pull request labels Oct 23, 2024
Copy link
Contributor Author

mergify bot commented Oct 23, 2024

Cherry-pick of 27fc737 has failed:

On branch mergify/bp/8.15/pr-4333
Your branch is up to date with 'origin/8.15'.

You are currently cherry-picking commit 27fc737c.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/en/observability/apm-ui/mobile-session-explorer.asciidoc
	modified:   docs/en/observability/apm/configure/general.asciidoc
	modified:   docs/en/observability/apm/configure/outputs/console.asciidoc
	modified:   docs/en/observability/apm/configure/outputs/kafka.asciidoc
	modified:   docs/en/observability/apm/configure/outputs/logstash.asciidoc
	modified:   docs/en/observability/apm/configure/outputs/redis.asciidoc
	modified:   docs/en/observability/apm/data-streams.asciidoc
	modified:   docs/en/observability/apm/ilm-how-to.asciidoc
	modified:   docs/en/observability/apm/images/bin-ov.png
	modified:   docs/en/observability/apm/ingest-pipelines.asciidoc
	deleted:    docs/en/observability/apm/shared-kibana-endpoint.asciidoc
	new file:   docs/en/observability/apm/shared/install-apm-integration-no-internet.asciidoc

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   docs/en/observability/apm-ui/troubleshooting.asciidoc
	both modified:   docs/en/observability/apm/getting-started-apm-server.asciidoc
	deleted by us:   docs/en/observability/apm/getting-started-apm/get-started-with-fleet-apm-server.asciidoc
	deleted by us:   docs/en/observability/apm/getting-started-apm/index.asciidoc
	both modified:   docs/en/observability/apm/upgrading-to-8.x.asciidoc

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Copy link
Contributor

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 merged commit b046eaa into 8.15 Oct 23, 2024
4 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/8.15/pr-4333 branch October 23, 2024 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport conflicts There is a conflict in the backported pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant