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.x](backport #4714) [apm] Clarify requirements in the Fleet-managed APM Server guide #4722

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jan 2, 2025

Description

Updates the Fleet-managed APM Server guide to address feedback from @eedugon including:

  • Let users know that they don't have to set up a Fleet Server if they already have one set up.
  • Let users know that that the APM integration doesn't have to run in the same agent that acts as the Fleet Server, but that is the easiest way to get started.

There are some points that @eedugon brought up in #4668 that are not addressed here including:

  • Shouldn't we rely and refer to the Fleet documentation for the Fleet Setup (if it's not already done)?
    The content for both the Prerequisites and Step 1: Set up Fleet sections come from the Fleet docs (here and here). We could link out to the Fleet guide instead of importing this content into this APM doc, but in my opinion we should only do that if it's the best user experience, not because of maintenance concerns. However, it would probably be a good idea to review the content in the elastic/ingest-docs repo to make sure it's up to date and as clear as possible.
  • Regarding the diagram on the getting started overview page: I don't think we should over complicate this diagram. The goal of this diagram is to help a new user get a high-level understanding of how the pieces relate to each other. If we're adding clarification in the step-by-step guide, I think it's ok if this diagram shows the simplest implementation.

@eedugon @bmorelli25 thoughts on this approach?

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 #4668

Checklist

  • 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:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

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

@mergify mergify bot added the backport label Jan 2, 2025
@mergify mergify bot requested a review from a team as a code owner January 2, 2025 16:21
Copy link
Contributor

github-actions bot commented Jan 2, 2025

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 enabled auto-merge (squash) January 2, 2025 16:31
@colleenmcginnis colleenmcginnis merged commit 9ba0e81 into 8.x Jan 2, 2025
8 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/8.x/pr-4714 branch January 2, 2025 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant