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] Clarify requirements in the Fleet-managed APM Server guide #4714

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

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>

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Dec 19, 2024
@colleenmcginnis colleenmcginnis self-assigned this Dec 19, 2024
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 marked this pull request as ready for review December 19, 2024 19:39
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner December 19, 2024 19:39
@bmorelli25
Copy link
Member

Your explanation makes sense to me. I'm supportive of this approach.

Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

I like the changes, and I'm totally ok with them. Thanks!

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.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Rework Fleet-managed APM Server get started guide
3 participants