Skip to content

Commit 758a14b

Browse files
committed
removing product traces docs; move to concepts
1 parent 6df7b6b commit 758a14b

File tree

10 files changed

+72
-77
lines changed

10 files changed

+72
-77
lines changed

docs/concepts/key-terms/tracing/distributed-tracing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Distributed Tracing
3-
sidebar_order: 10
3+
sidebar_order: 20
44
description: With distributed tracing, you can track software performance and measure throughput & latency, while seeing the impact of errors across multiple systems.
55
---
66

docs/concepts/key-terms/tracing/index.mdx

Lines changed: 65 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,73 @@ sidebar_order: 70
44
description: "Learn more about the tracing features Sentry offers to help you track your software performance across multiple systems."
55
---
66

7-
[Distributed tracing](/product/sentry-basics/tracing/distributed-tracing/) provides a connected view of related errors and transactions by capturing interactions among your software systems. With tracing, Sentry tracks your software performance and displays the impact of errors across multiple systems. Tracing issues back through services connects your front-end to your back-end.
7+
## What's Tracing?
88

9-
The [Trace View](/product/sentry-basics/tracing/trace-view/) allows you to drill down into the details of a single trace and traverse every transaction in that trace. This accelerates your ability to debug slow services, identify related errors, and root out other bottlenecks.
9+
Tracing is the process of capturing the timing and flow of requests and operations as they happen in your application. It's a powerful debugging tool, helping you identify which link in a sequence of events may be causing a problem, such as slow performance.
1010

11-
The [Trace Explorer](/product/explore/traces/) allows you to explore traces by querying [span properties](/concepts/search/searchable-properties/spans/). This helps you find relevant distributed traces that will give you more information to debug and optimize your code.
11+
![An illustrated image of the anatomy of a trace, showing 8 span blocks cascading in a waterfall pattern.](./img/The-anatomy-of-a-trace.png)
12+
13+
### What's Distributed Tracing?
14+
15+
Distributed tracing provides a unified view of how a single request moves from the frontend to the backend and beyond. This is particularly useful in modern applications, which are often composed of multiple separate services working together. To get a distributed view of your application, instrument Sentry in both your frontend and your backend.
16+
17+
With [distributed tracing](/concepts/key-terms/tracing/distributed-tracing/), you can identify performance bottlenecks that are affecting your application across different services and platforms. You can then use Sentry tools such as the [Trace Explorer](/product/explore/traces/) or [Trace View](/concepts/key-terms/tracing/trace-view/) page to dig deeper and find the root cause of the problem. Distributed tracing is particularly helpful for identifying problems that exist in actions taking place between multiple services that you can't debug using console logs, such as race conditions, [N+1 queries](/product/issues/issue-details/performance-issues/n-one-queries/), and [caching issues](/product/insights/caches/).
18+
19+
### What's a Trace?
20+
21+
A trace is a record of a series of connected events and operations coming from your application. Each trace has a string of globally unique characters called a trace ID that's passed between frontend and backend services. The trace ID connects all the actions that take place, starting from the moment a user performs an action on the frontend, all the way through to the actions this triggers across your application and services. Each trace is composed of multiple spans.
22+
23+
### What's a Span?
24+
25+
A span is a named, timed operation that represents a part of the application workflow. The data captured for each span provides granular insights into specific tasks, like API requests or database queries. Multiple spans are pieced together to create a trace, providing a comprehensive overview of how your application works. This makes it easier to troubleshoot and analyze performance issues.
26+
27+
### What are Span Attributes and Metrics?
28+
29+
Span attributes and metrics are key pieces of information that are captured for each span. Attributes are key-value pairs that provide additional context about the span, such as the name of the operation or the user ID. Metrics are numerical values that measure the performance of the span, such as the duration of the operation or the number of database queries.
30+
31+
### What's a Transaction?
32+
33+
In Sentry, a "transaction" is a specific unit that represents any event that your application sends to Sentry, like loading a web page or processing an API call. Each transaction is made up of one or more spans. Transactions have a unique transaction ID and include the associated child spans that capture the operation’s entire process from start to finish.
34+
35+
## How to Use Tracing in Sentry
36+
37+
If you instrument Sentry for a single part of your app (just the frontend for example), looking at a trace will provide useful context for debugging issues within that app or service. But to get the most out of tracing in Sentry, you'll need to instrument the frontend, the backend, and any services in-between with Sentry's SDK. Once this is done, there are several places where you can view and interact with tracing data:
38+
39+
### Traces to Trace View
40+
41+
You can view all the traces in your organization by going to the [Traces](https://sentry.io/orgredirect/organizations/:orgslug/traces/) page in Sentry. You'll see a chart and a list of traces and be able to see at-a-glance how long each trace took to complete and the number of spans it contains.
42+
43+
![A view of the Sentry Traces page showing traces and spans](./img/Traces-page.png)
44+
45+
If you want more information, click on any trace ID. This will take you to the [Trace View](/concepts/key-terms/tracing/trace-view/) page, which provides a more detailed view of the trace and its spans. Here, you'll see a waterfall view of the spans in the trace, which will show you how much time each service and operation took to complete, and may give you an indicator of where a problem may be coming from.
46+
47+
![A detailed view of the Senty Traces page showing an expaned trace and spans](./img/Trace-view-page.png)
48+
49+
Alternatively, you can use the search bar to look for spans by name, project, or other criteria. You can also use the tags section to filter spans by specific tags. Learn more about the Sentry [Trace Explorer](/product/explore/traces/).
50+
51+
![An illustrated image of the anatomy of a trace, showing 8 span blocks cascading in a waterfall pattern.](./img/Traces-details-page.png)
52+
53+
### Performance to Trace View
54+
55+
Depending on the size and volume of your app, you may have a lot of traces to sort through. The [Insights](https://sentry.io/orgredirect/organizations/:orgslug/insights/backend/) page in Sentry is a good place to get a high-level, aggregated view of your application's performance and focus in on the traces you care about. You'll see a list of transactions for specific pages, endpoints and parts of your application. Clicking on the transaction ID will take you to the Trace View page for that transaction. Learn more about using Sentry's [Insights](/product/insights/).
56+
57+
![An overview of the Performance page in Sentry.](./img/Performance-page.png)
58+
59+
## How Tracing Can Help You Debug
60+
61+
Sentry’s tracing lets you follow each request across various services, databases, and functions. This makes it easier to find exactly where an error occured or a performance bottleneck started. Below, you'll find some real-world scenarios where tracing saved the day.
62+
63+
### Debug Slowdowns Across Your Integrations
64+
65+
When debugging integrations or a microservice architecture, you'll likely run into issues where the root cause is tricky to discover, especially when it's a performance issue. At Sentry, we make sure to add spans whenever we’re working with external services, like Slack. Because of this, when our users started experiencing a 4-second delay in receiving Sentry alerts via Slack, we were able to go to the [Trace View](/concepts/key-terms/tracing/trace-view/) and quickly narrow down which task was causing the slowdown and deploy a fix quickly. Read more about the details of [debugging Sentry’s Slack Integration](https://blog.sentry.io/debugging-a-slack-integration-with-sentrys-trace-view/).
66+
67+
### Improve Core Web Vitals
68+
69+
While everyone is sharing Lighthouse scores, we all know that the true determination of healthy web vitals is when your actual users are using your application in their authentic environments. Sentry offers real insights and analysis of your application in the real world, and while tracing can be leveraged to reactively solve issues, you can also use it to proactively discover opportunities to improve your application performance. In fact, this blog post describes [how you can improve performance before your web page even loads](https://blog.sentry.io/how-to-make-your-web-page-faster-before-it-even-loads/).
70+
71+
### Debug New Code Bases Faster
72+
73+
Tracing can even give you the power to debug unfamiliar codebases. Although this benefit is not often discussed, a lot of time can be saved when debugging applications instrumented with Tracing, even if the codebase is completely new to you. Being able to trace actual user journeys throughout your application and see what happens across your entire stack contextualizes issues without even needing to recreate the issue locally. Read more about other ways [tracing helps developers debug](https://blog.sentry.io/everyone-needs-to-know-how-to-trace/) various issues here.
1274

1375
## Learn More
1476

docs/product/tracing/span-metrics/index.mdx renamed to docs/concepts/key-terms/tracing/span-metrics.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
22
title: Span Metrics
3-
description: "Learn how span metrics provide enhanced application performance monitoring by attaching custom metrics directly to trace spans."
3+
description: "Learn how span metrics provide enhanced application performance monitoring by attaching attributes to trace spans."
44
sidebar_order: 10
55
---
66

7-
# Span Metrics
8-
97
Span metrics enable you to attach metrics and important debugging context to your application's traces. This approach provides context-rich performance monitoring by connecting metrics directly to the operations that generate them.
108

119
## What Are Span Metrics?

docs/product/tracing/index.mdx

Lines changed: 0 additions & 69 deletions
This file was deleted.

redirects.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,11 @@ const userDocsRedirects = [
991991
},
992992
{
993993
source: '/product/explore/metrics/:path*',
994-
destination: '/product/tracing/span-metrics/',
994+
destination: '/concepts/key-terms/tracing/span-metrics/',
995+
},
996+
{
997+
source: '/product/tracing/:path*',
998+
destination: '/concepts/key-terms/tracing/:path*',
995999
},
9961000
// Redirects for JavaScript tracing docs
9971001
{

0 commit comments

Comments
 (0)