github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.11] [DOCS] Clean up APM UI docs (#169269) (#169411)

Browse source 
# Backport

This will backport the following commits from `main` to `8.11`:
- [[DOCS] Clean up APM UI docs
(#169269)](https://github.com/elastic/kibana/pull/169269)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Colleen
McGinnis","email":"colleen.mcginnis@elastic.co"},"sourceCommit":{"committedDate":"2023-10-19T14:42:45Z","message":"[DOCS]
Clean up APM UI docs (#169269)\n\nCloses
https://github.com/elastic/observability-docs/issues/3292\r\n\r\n##
Summary\r\n\r\nUpdates documentation related to the APM UI based on
issues found during\r\nthe Observability docs bug bash last
week.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x]
@colleenmcginnis\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials:\r\n- [x]
Clarify that distributed traces aren't the only colorful traces
in\r\n[Trace
sample\r\ntimeline](b707c3936b)\r\n-
[x] Clarify the implications of the traces table only showing
root\r\ntransactions
in\r\n[Traces](c1de678f91)\r\n-
[x] Add beta admonition to
APM\r\n[Infrastucture](d3bc4a972d)\r\n-
[x] @bmorelli25
review","sha":"7b0d842096500ef569f8d879d8fb913ac29cf318","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","v8.10.0","v8.11.0","v8.12.0"],"number":169269,"url":"https://github.com/elastic/kibana/pull/169269","mergeCommit":{"message":"[DOCS]
Clean up APM UI docs (#169269)\n\nCloses
https://github.com/elastic/observability-docs/issues/3292\r\n\r\n##
Summary\r\n\r\nUpdates documentation related to the APM UI based on
issues found during\r\nthe Observability docs bug bash last
week.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x]
@colleenmcginnis\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials:\r\n- [x]
Clarify that distributed traces aren't the only colorful traces
in\r\n[Trace
sample\r\ntimeline](b707c3936b)\r\n-
[x] Clarify the implications of the traces table only showing
root\r\ntransactions
in\r\n[Traces](c1de678f91)\r\n-
[x] Add beta admonition to
APM\r\n[Infrastucture](d3bc4a972d)\r\n-
[x] @bmorelli25
review","sha":"7b0d842096500ef569f8d879d8fb913ac29cf318"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.11"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/169269","number":169269,"mergeCommit":{"message":"[DOCS]
Clean up APM UI docs (#169269)\n\nCloses
https://github.com/elastic/observability-docs/issues/3292\r\n\r\n##
Summary\r\n\r\nUpdates documentation related to the APM UI based on
issues found during\r\nthe Observability docs bug bash last
week.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x]
@colleenmcginnis\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials:\r\n- [x]
Clarify that distributed traces aren't the only colorful traces
in\r\n[Trace
sample\r\ntimeline](b707c3936b)\r\n-
[x] Clarify the implications of the traces table only showing
root\r\ntransactions
in\r\n[Traces](c1de678f91)\r\n-
[x] Add beta admonition to
APM\r\n[Infrastucture](d3bc4a972d)\r\n-
[x] @bmorelli25
review","sha":"7b0d842096500ef569f8d879d8fb913ac29cf318"}}]}]
BACKPORT-->

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
This commit is contained in:
Kibana Machine 2023-10-19 11:07:09 -04:00 • committed by GitHub
parent 415c588955
commit 35306cf353
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/apm/infrastructure.asciidoc
View file

@ -2,6 +2,8 @@
[[infrastructure]]
=== Infrastructure
beta::[]
The *Infrastructure* tab provides information about the containers, pods, and hosts,
that the selected service is linked to.

5
docs/apm/spans.asciidoc
View file

@ -43,8 +43,9 @@ For example, quickly view:
[[distributed-tracing]]
==== Distributed tracing
If your trace sample timeline is colorful, it's indicative of a distributed trace.
Services in a distributed trace are separated by color and listed in the order they occur.
When a trace travels through multiple services it is known as a _distributed trace_.
In APM, the colors in a distributed trace represent different services and
are listed in the order they occur.
[role="screenshot"]
image::apm/images/apm-services-trace.png[Example of distributed trace colors in the APM app in Kibana]

4
docs/apm/traces.asciidoc
View file

@ -17,6 +17,10 @@ it's the collective amount of pain a specific endpoint is causing your users.
If there's a particular endpoint you're worried about, select it to view its
<<transaction-details,transaction details>>.
You can also use queries to filter and search the transactions shown on this page.
Note that only properties available on root transactions are searchable.
For example, you can't search for `label.tier: 'high'`, as that field is only available on non-root transactions.
[role="screenshot"]
image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in Kibana]