Skip to content

Commit 733c178

Browse files
sfanahataShannon Anahata
and
Shannon Anahata
authored
Update trace explorer doc for GA (#13560)
## DESCRIBE YOUR PR Updating trace explorer doc for GA - adding arcades, new screenshots, and a few text tweaks Deleting old trace explorer docs. closes #13539 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] Urgent deadline (GA date, etc.): First week of May - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ x] Checked Vercel preview for correctness, including links - [x ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [x ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent e96dc5b commit 733c178

19 files changed

+25
-98
lines changed

data-schemas

Submodule data-schemas deleted from 6d2c435
Loading
Loading
Loading
Loading
Loading

docs/product/explore/new-trace-explorer/index.mdx renamed to docs/product/explore/trace-explorer/index.mdx

+16-22
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
11
---
2-
title: "New Trace Explorer With Span-Based Metrics"
2+
title: "Trace Explorer With Span Metrics"
33
sidebar_order: 31
4-
description: "Learn how to use the new Sentry Trace Explorer to search span data, find distributed traces, and debug performance issues across your entire application stack."
4+
description: "Learn how to use Sentry's Trace Explorer to search span data, find distributed traces, and debug performance issues across your entire application stack."
55
---
66

7-
<Alert>
8-
The new Trace Explorer is currently an Early Adopter feature, to use it you
9-
will need to [enable your Early Adopter
10-
status](/organization/early-adopter-features/). If you are not an Early
11-
Adopter, you will still see the [classic Trace
12-
Explorer](/product/explore/traces/).
13-
</Alert>
14-
157
The [**Trace Explorer**](https://sentry.io/orgredirect/organizations/:orgslug/traces/) in Sentry is designed to make performance investigation easier and more intuitive. You can now explore span samples, visualize span attributes, and aggregate your data with flexible queries and filters. This guide will walk you through the key concepts and features of the Trace Explorer.
168

17-
![Trace Explorer Screenshot](./img/trace-explorer01.png)
9+
![Trace Explorer Screenshot](./img/Trace_Explorer_home.png)
1810

1911
## Key Concepts
2012

@@ -23,7 +15,7 @@ The [**Trace Explorer**](https://sentry.io/orgredirect/organizations/:orgslug/tr
2315
- A trace represents a single transaction or request through your system. This includes things like user browser sessions, HTTP requests, DB queries, middleware, caches and more.
2416
- It captures a series of operations (_spans_) that show how different parts of your application interacted during that transaction.
2517
- Each trace is identified by a **Trace ID**, which you can use to follow a request across services or projects.
26-
- A [distributed trace](/platforms/javascript/tracing/trace-propagation/#what-is-distributed-tracing) is composed of spans that traverse multiple servers, clients, edge workers, etc. and is assembled by passing the Trace ID through browser headers.
18+
- A [distributed trace](/platforms/javascript/tracing/trace-propagation/#what-is-distributed-tracing) is made of spans that traverse multiple servers, clients, edge workers, etc. and is assembled by passing the Trace ID through browser headers.
2719

2820
### Spans
2921

@@ -36,7 +28,6 @@ The [**Trace Explorer**](https://sentry.io/orgredirect/organizations/:orgslug/tr
3628

3729
- Span metrics are derived from applying a function to your span attributes (default or custom), like `p50(cart.value)` or `sum(ai.token_use)`, over a granular time frame. This calculation extrapolates metrics that then populate dashboards, alerts, etc. based on that rolling time window.
3830
- These 'metrics' aren't stored separately from your span data. Rather, they're queried on the fly. This reduces your need to manage, ingest, and store custom metrics.
39-
- The duration and granularity on which you can query your spans and extrapolate metrics depends on your plan - Developer: 7 days | Team: 14 days | Business: 30 days.
4031

4132
## Practical Examples
4233

@@ -47,21 +38,25 @@ The [**Trace Explorer**](https://sentry.io/orgredirect/organizations/:orgslug/tr
4738

4839
With these tools, the new Trace Explorer gives you powerful ways to understand your application's performance, identify bottlenecks, and make informed optimizations.
4940

41+
<Alert>
42+
You plan type determines your query window: Developer: 7 days | Team: 14 days | Business: 30 days.
43+
</Alert>
44+
5045
## Browsing Span and Trace Samples
5146

52-
Trace Explorer allows you to browse span and trace samples effortlessly. Here's how:
47+
Trace Explorer allows you to browse span and trace samples and inspect them. Here's how:
5348

5449
1. **Search for Samples**:
5550
- Use the search bar to filter results based on default or custom attributes, tags, etc. like `http.request_method is "GET`
56-
- **Edit and add** columns in teh span samples table to view any attribute
51+
- **Edit and add** columns in the span samples table to view any attribute
5752
- **Sort** by clicking the column header to toggle between ascending and descending
5853
- Switch between **Span Samples** and **Trace Samples** tabs depending on your focus.
5954
1. **Inspect Samples**:
6055

6156
- Clicking on a **Span ID** or **Trace ID** opens the **Trace Waterfall View**, showing the sequence of operations and their durations.
6257
- You can explore individual spans in detail or see the trace's overall structure.
6358

64-
![Trace Explorer Screenshot](./img/trace-explorer02.png)
59+
<Arcade src="https://demo.arcade.software/5W4Ra0nvz6eufKmnybix?embed" />
6560

6661
## Visualizing Span Attributes
6762

@@ -77,14 +72,13 @@ Trace Explorer makes it easy to visualize metrics aggregated from any span attri
7772

7873
The line chart updates dynamically as you apply filters, helping you track trends and identify anomalies.
7974

80-
![Trace Explorer Screenshot](./img/trace-explorer03.png)
81-
![Trace Explorer Screenshot](./img/trace-explorer04.png)
75+
<Arcade src="https://demo.arcade.software/6goWASyLCX3jx0kjKRMB?embed" />
8276

8377
## Aggregating Span Data
8478

8579
Dive deeper into your data with aggregation capabilities in Trace Explorer.
8680

87-
1. **Enable Aggregate Grouping** by clicking the **Aggregates** toggle.
81+
1. Click into the **Aggregates** tab.
8882

8983
2. **Group By Attributes** to investigate patterns.
9084

@@ -94,13 +88,13 @@ Dive deeper into your data with aggregation capabilities in Trace Explorer.
9488

9589
4. **View sample traces** that fit your aggregates by clicking the stack icon to the left side of the table rows. Use this to find outliers, debug issues, and find complex performance optimizations.
9690

97-
![Trace Explorer Screenshot](./img/trace-explorer05.png)
91+
<Arcade src="https://demo.arcade.software/rgVB85wJiopGNPO3KFJS?embed" />
9892

9993
## Create Alerts and Dashboard Widgets From Queries
10094

10195
You can create Alerts and Dashboard widgets from your queries by clicking the "Save As" button:
10296

103-
![Trace Explorer Screenshot](./img/trace-explorer06.png)
97+
![Trace Explorer Screenshot](./img/trace_explorer_save.png)
10498

10599
## Practical Examples
106100

@@ -203,7 +197,7 @@ Sentry treats this as a representation of the average across all 12 estimated sp
203197

204198
If your sampling rate is **too low** for an accurate extrapolation (for example, keeping less than 5% of an already low number of spans), Sentry may show a **low sampling rate warning**. This lets you know that extrapolation might be less reliable, especially for more restrictive queries.
205199

206-
![Trace Explorer Screenshot](./img/trace-explorer07.png)
200+
![Trace Explorer Screenshot](./img/Trace_explorer_low_samples.png)
207201

208202
Even if you sample your spans, **Trace Explorer's extrapolation gives you reasonably accurate answers** for counts, averages, and percentiles -- without you needing to do anything extra.
209203

Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/product/explore/traces/index.mdx

-75
This file was deleted.

redirects.js

+9
Original file line numberDiff line numberDiff line change
@@ -1153,6 +1153,15 @@ const userDocsRedirects = [
11531153
source: '/platforms/dart/guides/flutter/usage/advanced-usage/:path*',
11541154
destination: '/platforms/dart/guides/flutter/troubleshooting/:path*',
11551155
},
1156+
// Redirects for Trace Explorer
1157+
{
1158+
source: '/product/explore/traces',
1159+
destination: '/product/explore/trace-explorer/',
1160+
},
1161+
{
1162+
source: '/product/explore/new-trace-explorer',
1163+
destination: '/product/explore/trace-explorer/',
1164+
},
11561165
];
11571166

11581167
/**

0 commit comments

Comments
 (0)