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: Correlations #94620

Merged
merged 4 commits into from
Mar 16, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs: review feedback from @ogupte
bmorelli25 committed Mar 15, 2021
commit 0374934e9b98043e71eb4cc8345a98844e26feb6
42 changes: 31 additions & 11 deletions docs/apm/correlations.asciidoc
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
[[correlations]]
=== Find latency and error correlations

**Correlations** surfaces attributes of your data that are potentially correlated with high-latency or erroneous transactions.
**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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does user-defined mean here? My suggestion is to frame this as the surfaced attributes are some of the default attributes that are commonly known to cause performance issues like version/infrastructure and can be modified to include any attributes for custom analysis.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Fixed in #94750.

Find something interesting? A quick click of a button will auto-query your data as you work to resolve the underlying issue.

@@ -25,40 +25,60 @@ image::apm/images/correlations.png[Correlations]

Queries within the APM app apply to the correlations shown in the correlations fly-out.

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.

[discrete]
[[correlations-latency]]
==== Latency
==== Find high-latency correlations

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.
Attributes with a high impact, or attributes present in a large percentage of slow transactions,
may be contributing factors to increased latency.
may contribute to increased latency.

If a certain field or value seems noteworthy, use the **Filter** quick links:
To find high-latency correlations, hover over each potentially correlated attribute to
compare the latency distribution of transactions with and without the selected attribute.

* `+` 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.
For example, in the screenshot below, the field `user_agent.name` and value `HeadlessChrome`
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
`user_agent.name: HeadlessChrome`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.

[discrete]
[[correlations-error-rate]]
==== Error rate
==== Find error rate correlations

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.
Attributes with a high impact, or attributes present in a large percentage of failed transactions,
may be contributing factors to increased error rates.
may contribute to increased error rates.

If a certain field or value seems noteworthy, use the **Filter** quick links:
To find error rate correlations, hover over each potentially correlated attribute to
compare the error rate distribution of transactions with and without the selected attribute.

* `+` 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.
For example, in the screenshot below, the field `url.original` and value `http://localhost:3100...`
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
`url.original: http://localhost:3100...`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.

[discrete]
[[correlations-custom-fields]]
Binary file added docs/apm/images/correlations-hover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apm/images/error-rate-hover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.