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 decision tree diagram #4713

Merged
merged 4 commits into from
Dec 19, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Dec 19, 2024

Description

Updates the APM decision tree to address feedback from @eedugon including:

  • Clarifies that when we ask about using other integrations, we mean other integrations with APM Server.
  • Clarifies what we mean by running APM Server on the edge vs centrally.
    • Adds a brief description to the diagram itself.
    • Adds to the list of pros of using a Fleet-managed APM Server that you can centrally manage multiple APM Servers running on edge machines.

Note: In #4669 @eedugon mentioned that where the user is running APM Server (edge machine vs centrally) doesn't technically determine whether they must use Fleet-managed or APM Server binary. However, the goal of this section is to help a new user make a decision based on several factors not to be a complete reference of all implementations that are or aren't possible with Elastic APM. Is there anything we can change about the intro to the "Help me decide" section to make that clearer? @bmorelli25 any thoughts here?

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

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 16:38
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner December 19, 2024 16:38
@eedugon
Copy link
Contributor

eedugon commented Dec 19, 2024

The explanations look awesome in my opinion! I like it a lot.

Quick comment about one of them, not very important:

An APM agent and APM Server live on each edge machine

Considering an edge machine might (or typically) host multiple applications that could be instrumented, I would state it with something like:

  • APM agents and APM server live on each edge machine (just using the plural for APM agents).

Anyway your proposal looks good also.

The only pending issue I see in the diagram is this one:

image

I would suggest to find the way to state that the Fleet Server of the drawing colocated with the APM Server is not mandatory, just a suggestion in case the user doesn't have a Fleet Server already in place.

What I'd like to avoid is users thinking that they must deploy Fleet Server together with APM Server always.

(UPDATE: ops... I think this is covered in #4714 ) -> sorry for the noise!

@bmorelli25
Copy link
Member

Note: In #4669 @eedugon mentioned that where the user is running APM Server (edge machine vs centrally) doesn't technically determine whether they must use Fleet-managed or APM Server binary. However, the goal of this section is to help a new user make a decision based on several factors not to be a complete reference of all implementations that are or aren't possible with Elastic APM. Is there anything we can change about the intro to the "Help me decide" section to make that clearer? @bmorelli25 any thoughts here?

When the initial flowchart was created, one goal was to encourage folks who wanted to run APM Server on the edge to use Fleet-managed APM. That's not a goal anymore. I like the clarifications that Edu suggested. I also agree that this isn't meant to be a complete reference of all possibilities. Can we just directly say that? Something like:

Help me decide
This decision tree highlights key factors to help you make an informed decision about implementing Elastic APM. It provides practical guidance and is not intended to serve as a comprehensive reference of all possible implementations and capabilities.

@colleenmcginnis colleenmcginnis merged commit f1ce0e1 into elastic:main Dec 19, 2024
3 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4669 branch December 19, 2024 21:38
mergify bot pushed a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)
mergify bot pushed a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)
mergify bot pushed a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)
colleenmcginnis added a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Dec 19, 2024
* update apm decision tree diagram

* add pro to fleet-managed list

* address feedback from @eedugon

* address feedback from @bmorelli25

(cherry picked from commit f1ce0e1)

Co-authored-by: Colleen McGinnis <[email protected]>
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 APM decision tree diagram
3 participants