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] docs: restructure APM documentation for 7.7 #63280

Merged
merged 14 commits into from
Apr 15, 2020

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Apr 10, 2020

Summary

This PR:

  • Separates non-reference content from reference content to create a triage location for guide content as we adapt what we have into how-to guides, and begin to create more task-focussed documentation.
  • Improves the TOC structure and headings by moving content from the "Using APM" bucket, and making use of table abbreviations to simplify the TOC headings.

In addition, this PR:

  • Explains where supported configurations for central config are documented
  • Updates service map documentation with feedback from @nehaduggal

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.html
https://www.elastic.co/guide/en/kibana/current/xpack-apm.html

Screenshots

This is the proposed content structure:

collapsed

Screen Shot 2020-04-10 at 12 46 19 PM

expanded

Screen Shot 2020-04-10 at 12 32 50 PM

Related Issues

Closes #60462.
Closes elastic/apm#232.
Closes #63510.
Closes #63475.

@bmorelli25 bmorelli25 added Team:APM All issues that need APM UI Team support release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Apr 10, 2020
@bmorelli25 bmorelli25 self-assigned this Apr 10, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@bmorelli25
Copy link
Member Author

@bmorelli25
Copy link
Member Author

bmorelli25 commented Apr 10, 2020

I need to fix a link in the APM Overview before the docs preview will work.

12:47:14 INFO:build_docs:Bad cross-document links:
12:47:14 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/get-started/master/components.html:
12:47:14 INFO:build_docs:   - en/kibana/master/apm-bottlenecks.html

EDIT: Links updated in elastic/apm-server#3643.

Copy link

@nehaduggal nehaduggal left a 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.

docs/apm/service-maps.asciidoc Outdated Show resolved Hide resolved
docs/apm/service-maps.asciidoc Outdated Show resolved Hide resolved
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,

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.

@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs

@bmorelli25 bmorelli25 requested a review from a team April 10, 2020 20:04
@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs

@bmorelli25
Copy link
Member Author

Based on feedback from @nehaduggal , I’ve made the following additional changes:

  • PR feedback
  • Defined traces in traces.asciidoc and getting-started.asciidoc
  • Moved deployment annotations to how-to section
  • Renamed “advanced queries” to “query your data"
  • Added an example to the “query your data” page, and reworked content
  • Improved APM settings description and added links to index details in the APM Server reference

Other changes:

  • More clean up
  • Moves watcher error reports to how-to section

To do / questions:

  • Explain how to enable ML in machine-learning-integration.html
  • Need to figure out what to do with the distributed tracing content in traces.asciidoc. This is really just copied over information from the APM Overview, and it wouldn’t even be necessary if all of our documentation lived in one place. I wonder if we can turn it into task based and move it into the how-to section. Something like, “Visualize distributed traces”, and talk about the span waterfall and service maps

Copy link
Member

@dgieselaar dgieselaar left a 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

@bmorelli25
Copy link
Member Author

Taking care of #63510 in this PR since I already have it open. See 4594da6.

@bmorelli25
Copy link
Member Author

bmorelli25 commented Apr 14, 2020

Added #63475 in ad3c5f3. Still need to confirm the accuracy of the list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.7.0
Projects
None yet
4 participants