Skip to content

Add dedicated traces view docs#5547

Open
alexandra5000 wants to merge 4 commits intoelastic:mainfrom
alexandra5000:traces-discover
Open

Add dedicated traces view docs#5547
alexandra5000 wants to merge 4 commits intoelastic:mainfrom
alexandra5000:traces-discover

Conversation

@alexandra5000
Copy link
Contributor

Summary

This PR closes #3020 and adds docs for the traces-specific Discover view.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Claude Sonnet 4.6

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
solutions/observability/apm/discover-traces.md 13 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Comment on lines +39 to +43
The traces experience is available in:

* **{{data-source-cap}} mode**: Select a {{data-source}} that matches a `traces-*` index pattern from the **Discover** main page.

* **{{esql}} mode**: Select **Try {{esql}}** and use the `FROM` command to query your trace data:
Copy link
Contributor Author

@alexandra5000 alexandra5000 Mar 18, 2026

Choose a reason for hiding this comment

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

I was able to use it in both modes when testing, but I used 9.3.1 - to be confirmed if it works in data view on 9.2 as well.

@alexandra5000 alexandra5000 marked this pull request as ready for review March 18, 2026 16:52
@alexandra5000 alexandra5000 requested review from a team as code owners March 18, 2026 16:52
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

Looks excellent. Just left a few conceptual questions for your consideration — hope they're helpful, ignore 'em if not!


### Data recognition [traces-data-recognition]

By default, data stored in `traces-*` indices is recognized as trace data and triggers the **Discover** experience described on this page.
Copy link
Contributor

Choose a reason for hiding this comment

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

If we're going to say this is the default behavrior, maybe worth mentioning how to change the default?


## Traces-specific features [traces-specific-features]

When **Discover** recognizes trace data, it pre-selects a set of relevant fields as columns in the data grid: `service.name`, `transaction.name`, `span.name`, `transaction.duration.us`, `span.duration.us`, and `event.outcome`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe link to more info about how to change which columns are selected, if relevant.

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

Overall LGTM! It looks like there might be some differences depending on the version you're using with the ES|QL button and some headings in details flyout. I could also see the updated details flyout when using a 9.3 deployment, but I couldn't see the new Latency, Error rate, and Throughput charts. That could be operator error however 😄.

@@ -0,0 +1,121 @@
---
applies_to:
stack: preview 9.2
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure this was available in 9.2? I'm seeing the traces features in ES|QL view when using Serverless and 9.4, but not in 9.3. Maybe the deployments I have access to don't have the right data.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see it in 9.3 for sure, should be available in 9.2 as well - @davismcphee could you confirm please?


* **{{data-source-cap}} mode**: Select a {{data-source}} that matches a `traces-*` index pattern from the **Discover** main page.

* **{{esql}} mode**: Select **Try {{esql}}** and use the `FROM` command to query your trace data:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the button in serverless and 9.4 now just says "</> ES|QL"

Image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't have access to the 9.4 deployment, in my version is still says "Try ESQL". I might have to create tabs for stack vs serverless


Select **Open in Discover** to open a filtered view of all similar spans.

### Trace waterfall [trace-waterfall]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Trace waterfall [trace-waterfall]
### Trace summary [trace-waterfall]

Looks like the name in the actual UI is "Trace summary" now? Looks like this is maybe a 9.4 and serverless update right now.

Image


### Trace waterfall [trace-waterfall]

The **Trace** section shows a condensed waterfall of the trace the selected document belongs to. Each row represents a span or transaction, positioned on a timeline to show when it started and how long it took.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The **Trace** section shows a condensed waterfall of the trace the selected document belongs to. Each row represents a span or transaction, positioned on a timeline to show when it started and how long it took.
The **Trace summary** section shows a condensed waterfall of the trace the selected document belongs to. Each row represents a span or transaction, positioned on a timeline to show when it started and how long it took.

This heading might be version-dependent since I see your screenshot is showing as "Trace"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, looks like it - I don't have access to 9.4 yet though. Thanks for pointing it out!

@alexandra5000
Copy link
Contributor Author

Hi @davismcphee could you please review / check if this is technically correct? 🙏

Copy link
Contributor

@davismcphee davismcphee left a comment

Choose a reason for hiding this comment

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

Thanks for the ping and adding traces docs! Left a few minor comments, but nothing blocking.

@@ -0,0 +1,121 @@
---
applies_to:
stack: preview 9.2+
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it was technically 9.1 since that's when this PR merged: elastic/kibana#224869.

applies_to:
stack: preview 9.2+
serverless: preview
description: Explore trace data in Discover using the traces profile.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Profile" is more of an implementation detail than a user concept. I think we've been avoiding it so far in other Discover docs.

# Explore traces in Discover [explore-traces-discover]

:::{important}
This functionality is experimental and not supported. It may change or be removed at anytime.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: I don't really understand what "unsupported" means in this context.

This functionality is experimental and not supported. It may change or be removed at anytime.
:::

**Discover** offers a dedicated experience for exploring trace data. When **Discover** detects data in `traces-*` indices, it automatically selects relevant fields and enables features that help you investigate distributed traces more effectively. The traces experience includes a pre-selected set of trace fields in the data grid, a structured overview of each document's key attributes, latency comparisons for similar spans, and a waterfall visualization of the full trace timeline.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Discover** offers a dedicated experience for exploring trace data. When **Discover** detects data in `traces-*` indices, it automatically selects relevant fields and enables features that help you investigate distributed traces more effectively. The traces experience includes a pre-selected set of trace fields in the data grid, a structured overview of each document's key attributes, latency comparisons for similar spans, and a waterfall visualization of the full trace timeline.
**Discover** offers a dedicated experience for exploring trace data. When **Discover** detects data in `traces-*` indices, it automatically enables features that help you investigate distributed traces more effectively. The traces experience includes a pre-selected set of trace fields in the data grid, a structured overview of each document's key attributes, latency comparisons for similar spans, and a waterfall visualization of the full trace timeline.

Nit: we mention default fields two sentences in a row. I think it would still read well if we dropped the first occurrence.

:screenshot:
:::

Select **Expand trace timeline** to open the full-screen waterfall view.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's no longer a full screen view, they replaced it with a dedicated flyout view. Maybe we could just go with "to open the expanded waterfall view" or similar instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create docs for Discover profile: Traces

4 participants