-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
add new tracing docs page [DRAFT] #11466
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
Closed
Closed
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c3b9040
add new tracing docs page
lizokm 308aa21
Update docs/product/tracing/index.mdx
lizokm 3aea306
update docs
lizokm c9bec22
Update docs/product/tracing/index.mdx
lizokm d5c25d5
Update docs/product/tracing/index.mdx
lizokm 3639d32
Update docs/product/tracing/index.mdx
lizokm 493e6a1
Update docs/product/tracing/index.mdx
lizokm 9759fb1
Update docs/product/tracing/index.mdx
lizokm 03141e7
Update docs/product/tracing/index.mdx
lizokm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: Tracing | ||
| sidebar_order: 20 | ||
| description: "Learn about tracing and distributed tracing and how it can be used to not just observe, but also debug application performance issues." | ||
| --- | ||
|
|
||
| ## What's Tracing? | ||
|
|
||
| Tracing is the process of tracking the flow and timing of requests and operations as they happen throughout your entire application. Each trace has a unique identifier that's shared between backend, frontend, and other services, connecting them. This makes it possible to look at a trace and see an entire chain of events that may have lead to an error or other issue. This helps you understand the impact of errors across your full stack and microservices. | ||
|
|
||
| ### What's Distributed Tracing? | ||
|
|
||
| Distributed tracing enables you to trace and visualize interactions between multiple instrumented services, allowing you to identify performance bottlenecks that are affecting your application no matter where (frontend, backend, other) they're coming from. You can then use the Sentry [Trace Explorer](/product/explore/traces/) and [Trace View](/concepts/key-terms/tracing/trace-view/) to dig deeper to find the root cause. 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/). | ||
|
|
||
| While Sentry tracing can be useful if instrumented in just the frontend or the backend, it's most powerful when set up for your full stack (distributed tracing). This is especially true if you use microservices. Even if you mostly work on the frontend, frontend problems often require backend fixes, and setting up Sentry for your backend can help you find the root cause of a problem faster. Distributed tracing also helps you understand how different parts of the system interact. | ||
|
|
||
| **Distributed tracing can help with:** | ||
|
|
||
| - Identifying performance bottlenecks by finding the root cause of slow requests | ||
| - Debugging frontend and backend problems | ||
| - Understanding how different parts of the system interact | ||
| - Highlighting operations or endpoints that consume the most time | ||
|
|
||
| ### Traces | ||
|
|
||
| A trace is a unique identifier that tracks a complete operation across multiple services. Every event sent to Sentry (Errors, Spans, Replays, Profiles, and so on) will have a trace id linking frontend and backend events together. | ||
|
|
||
| ### Spans | ||
|
|
||
| A span is a single unit of work or operation within a trace. It represents a specific task, like an API call, a database query, or a rendering process. Spans include details like start and end times, helping measure the duration of each task and identify bottlenecks or failures. In distributed tracing, spans are connected to show how tasks across different services interact. | ||
|
|
||
| ### Transactions | ||
|
|
||
| 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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.