mirror of
https://github.com/elastic/kibana.git
synced 2025-04-22 08:49:27 -04:00
166c454413
# Backport This will backport the following commits from `main` to `8.9`: - [[APM] Documentation updates (#160951)](https://github.com/elastic/kibana/pull/160951) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Brandon Morelli","email":"brandon.morelli@elastic.co"},"sourceCommit":{"committedDate":"2023-06-30T18:49:43Z","message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","v8.9.0","v8.8.2","v8.10.0"],"number":160951,"url":"https://github.com/elastic/kibana/pull/160951","mergeCommit":{"message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3"}},"sourceBranch":"main","suggestedTargetBranches":["8.9","8.8"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.8","label":"v8.8.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/160951","number":160951,"mergeCommit":{"message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3"}}]}] BACKPORT--> Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
48 lines
2.3 KiB
Text
48 lines
2.3 KiB
Text
[role="xpack"]
|
|
[[dependencies]]
|
|
=== Dependencies
|
|
|
|
APM agents collect details about external calls made from instrumented services.
|
|
Sometimes, these external calls resolve into a downstream service that's instrumented -- in these cases,
|
|
you can utilize <<distributed-tracing,distributed tracing>> to drill down into problematic downstream services.
|
|
Other times, though, it's not possible to instrument a downstream dependency --
|
|
like with a database or third-party service.
|
|
**Dependencies** gives you a window into these uninstrumented, downstream dependencies.
|
|
|
|
[role="screenshot"]
|
|
image::apm/images/dependencies.png[Dependencies view in the APM app in Kibana]
|
|
|
|
Many application issues are caused by slow or unresponsive downstream dependencies.
|
|
And because a single, slow dependency can significantly impact the end-user experience,
|
|
it's important to be able to quickly identify these problems and determine the root cause.
|
|
|
|
Select a dependency to see detailed latency, throughput, and failed transaction rate metrics.
|
|
|
|
[role="screenshot"]
|
|
image::apm/images/dependencies-drilldown.png[Dependencies drilldown view in the APM app in Kibana]
|
|
|
|
When viewing a dependency, consider your pattern of usage with that dependency.
|
|
If your usage pattern _hasn't_ increased or decreased,
|
|
but the experience has been negatively effected -- either with an increase in latency or errors,
|
|
there's likely a problem with the dependency that needs to be addressed.
|
|
|
|
If your usage pattern _has_ changed, the dependency view can quickly show you whether
|
|
that pattern change exists in all upstream services, or just a subset of your services.
|
|
You might then start digging into traces coming from
|
|
impacted services to determine why that pattern change has occurred.
|
|
|
|
[float]
|
|
[[dependencies-operations]]
|
|
==== Operations
|
|
|
|
beta::[]
|
|
|
|
**Dependency operations** provides a granular breakdown of the operations/queries a dependency is executing.
|
|
|
|
[role="screenshot"]
|
|
image::apm/images/operations.png[operations view in the APM app in Kibana]
|
|
|
|
Selecting an operation displays the operation's impact and performance trends over time, via key metrics like latency, throughput, and failed transaction rate. In addition, the <<spans,**Trace sample timeline**>> provides a visual drill-down into an end-to-end trace sample.
|
|
|
|
[role="screenshot"]
|
|
image::apm/images/operations-detail.png[operations detail view in the APM app in Kibana]
|