maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[APM] docs: correlations feedback (#94750) (#94852)

Browse source
This commit is contained in:
Brandon Morelli 2021-03-17 13:11:24 -07:00 committed by GitHub
parent 4d8bf72449
commit 19d88f1302
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
docs/apm/correlations.asciidoc
View file

@ -3,7 +3,8 @@
=== Find latency and error correlations
**Correlations** surface attributes of your data that are potentially correlated with high-latency or erroneous transactions.
Surfaced attributes are user-defined, meaning that they are completely customizable to your APM data.
By default, a number of attributes commonly known to cause performance issues, like version,
infrastructure, and location, are included, but all are completely customizable to your APM data.
Find something interesting? A quick click of a button will auto-query your data as you work to resolve the underlying issue.
For example, a site reliability engineer, who is responsible for keeping production systems up and running,
@ -11,8 +12,7 @@ notices an increase in latency in certain transactions.
Analyzing metadata or tags that exist in high-latency transactions but not in lower-latency transactions
can potentially point towards the root cause.
They may find that a particular piece of hardware, like a host or pod, has failed, increasing latency.
Or, perhaps a set of users, based on IP address or region, is physically too far away from the nearest
data center, increasing latency.
Or, perhaps set of users, based on IP address or region, is facing increased latency due to local data center issues.
[discrete]
[[view-correlations]]
@ -27,8 +27,8 @@ Queries within the APM app apply to the correlations shown in the correlations f
If a correlated field seems noteworthy, use the **Filter** quick links:
* `+` creates a new query in the APM app for transactions containing the selected value.
* `-` creates a new query in the APM app for transactions without the selected value.
* `+` creates a new query in the APM app for filtering transactions containing the selected value.
* `-` creates a new query in the APM app to filter out transactions containing the selected value.
[discrete]
[[correlations-latency]]
@ -37,8 +37,9 @@ If a correlated field seems noteworthy, use the **Filter** quick links:
Correlations help you discover which fields are contributing to increased service latency.
A latency distribution chart visualizes the overall latency of the selected service's transactions.
Correlated attributes are sorted by _Impact_–a visual representation of the score for the underlying
aggregation that powers correlations.
Correlated attributes are sorted by _Impact_–a visual representation of the
{ref}/search-aggregations-bucket-significantterms-aggregation.html[significant terms aggregation]
score that powers correlations.
Attributes with a high impact, or attributes present in a large percentage of slow transactions,
may contribute to increased latency.
@ -51,10 +52,15 @@ exists primarily in higher-latency transactions between 3.7 and 8.7 seconds.
[role="screenshot"]
image::apm/images/correlations-hover.png[Correlations hover effect]
Selecting the `+` filter creates a new query in the APM app for transactions with
Select the `+` filter to create a new query in the APM app for transactions with
`user_agent.name: HeadlessChrome`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.
As you sift through high-latency transactions, you'll likely notice other interesting attributes.
Return to the correlations fly-out and select *Customize fields* to search on these new attributes.
You may need to do this a few times–each time filtering out more and more noise and bringing you
closer to a diagnosis.
[discrete]
[[correlations-error-rate]]
==== Find error rate correlations
@ -62,8 +68,9 @@ you can begin viewing sample traces to continue your investigation.
Correlations help you discover which fields are contributing to failed transactions.
The Error rate over time chart visualizes the change in error rate over the selected time frame.
Correlated attributes are sorted by _Impact_–a visual representation of the score for the underlying
aggregation that powers correlations.
Correlated attributes are sorted by _Impact_–a visual representation of the
{ref}/search-aggregations-bucket-significantterms-aggregation.html[significant terms aggregation]
score that powers correlations.
Attributes with a high impact, or attributes present in a large percentage of failed transactions,
may contribute to increased error rates.
@ -76,16 +83,41 @@ existed in 100% of failed transactions between 6:00 and 10:30.
[role="screenshot"]
image::apm/images/error-rate-hover.png[Correlations errors hover effect]
Selecting the `+` filter creates a new query in the APM app for transactions with
Select the `+` filter to create a new query in the APM app for transactions with
`url.original: http://localhost:3100...`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.
As you sift through erroneous transactions, you'll likely notice other interesting attributes.
Return to the correlations fly-out and select *Customize fields* to search on these new attributes.
You may need to do this a few times–each time filtering out more and more noise and bringing you
closer to a diagnosis.
[discrete]
[[correlations-custom-fields]]
[[correlations-customize-fields]]
==== Customize fields
Correlations are only as good as the data they're searching for.
By default, a handful of potentially useful fields are selected, like `lables`, `service.version`, and `host.ip`.
You can remove and add fields to this list under the **Customize fields** dropdown.
By default, a handful of attributes commonly known to cause performance issues are included.
During the course of an investigation however, you may to need to add and remove fields from
this list multiple times as you narrow in on a diagnosis.
Add and remove fields under the **Customize fields** dropdown.
The following fields are selected by default.
To keep the default list manageable, only the first six matching fields with wildcards are used.
**Frontend (RUM) agent:**
* `labels.*`
* `user.*`
* `user_agent.name`
* `user_agent.os.name`
* `url.original`
**Backend agents:**
* `labels.*`
* `host.ip`
* `service.node.name`
* `service.version`
TIP: Want to start over? Select **reset** to clear your customizations.

2
docs/apm/troubleshooting.asciidoc
View file

@ -20,7 +20,7 @@ don't forget to check our other troubleshooting guides or discussion forum:
* {apm-php-ref}/troubleshooting.html[PHP agent troubleshooting]
* {apm-py-ref}/troubleshooting.html[Python agent troubleshooting]
* {apm-ruby-ref}/debugging.html[Ruby agent troubleshooting]
* {apm-rum-ref/troubleshooting.html[RUM troubleshooting]
* {apm-rum-ref}/troubleshooting.html[RUM troubleshooting]
* https://discuss.elastic.co/c/apm[APM discussion forum].
[discrete]