[APM] docs: Correlations #94620
[APM] docs: Correlations #94620
Conversation
|
Pinging @elastic/apm-ui (Team:apm) |
bmorelli25
added
release_note:skip
|
One thing we'll definitely want to include/illustrate is the ability to hover over a specific significant term/value in the table to compare it with the overall distribution in latency/failures. For example, Here's a screenshot with a interesting curve in latency distribution related to one specific browser type: |
|
Thanks, Oliver! Updated the docs to reflect that flow. |
💚 Build Succeeded
Metrics [docs]Async chunks
History
To update your PR or re-run it, just comment with: cc @bmorelli25 |
| With a service selected, click **View correlations**: | ||
|
|
||
| [role="screenshot"] | ||
| image::apm/images/correlations.png[Correlations] |
There was a problem hiding this comment.
@bmorelli25 I noticed for all the screenshots that we're using the v8 theme - was this decided within the docs team that any new screenshots would use the "not yet" released theme? Just wondering since I don't think we're shipping the theme publically until a few minors.
There was a problem hiding this comment.
🤦 This is an oversight on my part
|
@bmorelli25 Great read! You made it sound a lot less complicated ;) |
| === Find latency and error correlations | ||
|
|
||
| **Correlations** surfaces 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Good point. Fixed in #94750.
|
Thanks for the reviews, everyone! Merging this in as-is and will open a follow-up PR addressing review feedback. |
|
Feedback addressed in #94750. |
Summary
This PR adds documentation for APM's new correlations feature.
Doc preview
Click here for a preview
Related
For #86477.
Implementation #89952.