-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New tracing product page #11607
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
New tracing product page #11607
Changes from 6 commits
0c7ae64
2df08b9
f3fff95
c35c866
e6a50f5
cfedcd4
1d9322d
1bf7b75
1cf8e38
e9f5e94
8729599
9a28b5f
1772a8a
ffcdf77
32d237f
e6aa6fe
d85fa5b
0ecf844
eb266a2
b5c1d40
abed374
7d08460
4552106
7f7ad40
6c6ce7f
71b1a31
0d60d33
be66076
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Tracing | ||
| sidebar_order: 20 | ||
| description: "Learn about using tracing and distributed tracing for observing and debugging application performance issues. You'll see the impact of errors across your full stack and microservices." | ||
| --- | ||
|
|
||
| ## Tracing | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Tracing is the process of capturing the timing and flow of requests and operations as they happen throughout your application. It can be a powerful debugging tool, helping you identify which link in a sequence of events is causing a problem. | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### What's Distributed Tracing? | ||
|
|
||
| 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 services working together. To get a distributed view of your application, instrument Sentry in both your frontend and your backend. | ||
|
|
||
| With distributed tracing, you can identify performance bottlenecks that are affecting your application no matter where in your application's workflow they occur. 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 you can't just debug using console logs, such as race conditions, [N+1](/product/issues/issue-details/performance-issues/n-one-queries/), and [caching issues](/product/insights/caches/). | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### What's a Trace? | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like this section does a good job of defining a 'trace ID' but not a 'trace'. Maybe start with a sentence that's a higher level overview; like, 'A trace is a unique record of a set of related actions happening in your application.'
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good point! |
||
|
|
||
| Each trace has a string of globally unique characters called a trace ID, that's shared by both frontend and backend services they help connect all the actions that take place to make an event such as a button click or a page scroll. Each trace is composed of multiple spans. | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### What's a Span? | ||
| A span is a named, timed operation that represents a part of the application workflow. It provides granular insights into specific tasks, like API requests or database queries. Multiple spans are pieced together to create a trace. providing a comprehensive view of its path, timing, and interactions for troubleshooting and performance analysis. | ||
|
||
|
|
||
| ### What's a Transaction? | ||
|
|
||
| Transactions are a Sentry-specific unit of measurement that references any event that users send to Sentry. In addition to standard event fields, transactions also contains child spans and have a unique transaction ID. | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## How to Use Tracing in Sentry | ||
|
|
||
| To get the most out of tracing in Sentry, you'll need to instrument both the frontend and backend of your application with Sentry's SDK. Once this is done, there are several places where you can view and interact with tracing data: | ||
|
||
|
|
||
| ### Traces to Trace View | ||
|
|
||
| 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. | ||
lizokm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If you want more information, click on any trace ID. This will take you to the [Trace View](https://sentry.io/orgredirect/organizations/:orgslug/traces/:traceid/) 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 long each service and process took to complete and may give you an indicator of where a problem may be coming from. Learn more about the Sentry [Trace View](/platform/explore/trace-view/). | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Alternatively, you can use the search bar to look for traces by name, project, or other criteria. You can also use the tags section to filter traces by specific tags. Learn more about the Sentry [Trace Explorer](/platform/explore/trace-explorer/). | ||
|
|
||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ### Performance to Trace View | ||
|
|
||
| If you're interested in a high-level view of your application's performance, you can start from the [Performance](https://sentry.io/orgredirect/organizations/:orgslug/performance/) page in Sentry where you'll see a list of transactions. Clicking on the transaction ID will take you to the Trace View page for that transaction. Learn more about using Sentry's [Performance Monitoring](/platform/performance-monitoring/). | ||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Uh oh!
There was an error while loading. Please reload this page.