-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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] docs: restructure APM documentation for 7.7 #63280
Conversation
Pinging @elastic/apm-ui (Team:apm) |
@nehaduggal See https://github.com/elastic/kibana/pull/63280/files#diff-369bdd3f2877c4bfb5c34e738980fc81 for service map updates |
I need to fix a link in the APM Overview before the docs preview will work.
EDIT: Links updated in elastic/apm-server#3643. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few comments.
Service maps rely on distributed traces to draw connections between services. | ||
As {apm-overview-ref}/distribute-tracing.html[distributed tracing] is enabled out-of-the-box for supported technologies, so are service maps. | ||
However, if a service isn't instrumented, | ||
or a `traceparent` header isn't being propagated to it, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"or is unable to propagate a traceparent
header" Because you can see external service and database calls and won't see things like load balancers because they themselves don't explicitly propagate the traceparent header. Maybe we can specify what things can't propagate headers explicitly - e.g. load balancers, databases, message queues.
@elasticmachine, run elasticsearch-ci/docs |
@elasticmachine, run elasticsearch-ci/docs |
Based on feedback from @nehaduggal , I’ve made the following additional changes:
Other changes:
To do / questions:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work Brandon - one suggestion about alert tags that I should have given earlier, but other than LGTM
Summary
This PR:
In addition, this PR:
Reviewers: Please visit the doc preview link and click around. Any feedback on the new structure is welcome.
Doc preview
http://kibana_63280.docs-preview.app.elstc.co/guide/en/kibana/master/xpack-apm.htmlhttps://www.elastic.co/guide/en/kibana/current/xpack-apm.html
Screenshots
This is the proposed content structure:
collapsed
expanded
Related Issues
Closes #60462.
Closes elastic/apm#232.
Closes #63510.
Closes #63475.