Move /usage/distributed-tracing to /tracing #9572
Closed
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will decrease total bundle size by 4.05kB ⬇️
|
HazAT
approved these changes
Mar 28, 2024
Jeffreyhung
approved these changes
Mar 28, 2024
lizokm
approved these changes
Mar 28, 2024
| @@ -0,0 +1,34 @@ | |||
| --- | |||
| title: Tracing | |||
| description: "Learn how to connect events across applications/services." | |||
There was a problem hiding this comment.
Suggested change
| description: "Learn how to connect events across applications/services." | |
| description: "Learn how to connect events across multiple applications and services using tracing." |
| sidebar_order: 40 | ||
| --- | ||
|
|
||
| If the overall application landscape that you want to observe with Sentry consists of more than just a single service or application, distributed tracing can add a lot of value. |
There was a problem hiding this comment.
Suggested change
| If the overall application landscape that you want to observe with Sentry consists of more than just a single service or application, distributed tracing can add a lot of value. | |
| Tracing allows you to see interactions across multiple systems. If your application relies on more than one service, setting up tracing can help catch issues earlier and faster by providing a holistic view of your application landscape. | |
|
|
||
| If the overall application landscape that you want to observe with Sentry consists of more than just a single service or application, distributed tracing can add a lot of value. | ||
|
|
||
| ## What is Tracing? |
There was a problem hiding this comment.
Suggested change
| ## What is Tracing? | |
| ## What Is Tracing? |
Comment on lines
+10
to
+14
|
|
||
| In the context of a distributed system, tracing acts as a powerful debugging tool. Imagine your application as a vast network of interconnected parts. For example, your system might be spread across different servers or your application might split into different backend and frontend services, each potentially having their own technology stack. | ||
|
|
||
| When an error or performance issue occurs, it can be challenging to pinpoint the root cause due to the complexity of such a system. Tracing helps you follow the path of an event as it travels through this intricate web, recording every step it takes. By examining these traces, you can reconstruct the sequence of events leading up to the event of interest, identify the specific components involved, and understand their interactions. This detailed visibility enables you to diagnose and resolve issues more effectively, ultimately improving the reliability and performance of your distributed system. | ||
|
|
There was a problem hiding this comment.
Suggested change
| In the context of a distributed system, tracing acts as a powerful debugging tool. Imagine your application as a vast network of interconnected parts. For example, your system might be spread across different servers or your application might split into different backend and frontend services, each potentially having their own technology stack. | |
| When an error or performance issue occurs, it can be challenging to pinpoint the root cause due to the complexity of such a system. Tracing helps you follow the path of an event as it travels through this intricate web, recording every step it takes. By examining these traces, you can reconstruct the sequence of events leading up to the event of interest, identify the specific components involved, and understand their interactions. This detailed visibility enables you to diagnose and resolve issues more effectively, ultimately improving the reliability and performance of your distributed system. | |
| If you're working within a distributed system where your application is a vast network of interconnected parts, tracing can be a powerful debugging tool. | |
| Trying to pinpoint the root cause of an error or performance issue in a system that's spread across different servers, or split into different backend and frontend services (each with their own technology stack), can be challenging. | |
| Tracing helps you follow the path of an event as it travels through this intricate web, recording every step it takes. By looking at traces, you can reconstruct the sequence of events that lead up to the event of interest, identify the components involved, and understand their interactions. This detailed visibility lets you diagnose and resolve issues more effectively and improve the overall reliability and performance of your distributed system. | |
|
|
||
| This trace shows a Vue app's `pageload` making a request to a Python backend, which then calls the `/api` endpoint of a Ruby microservice. | ||
|
|
||
| What happens in the background is that Sentry uses reads and further propagates two HTTP headers between your applications: |
There was a problem hiding this comment.
Suggested change
| What happens in the background is that Sentry uses reads and further propagates two HTTP headers between your applications: | |
| In the background, Sentry uses reads and further propagates two HTTP headers between your applications: |
| @@ -72,7 +72,7 @@ When using custom instrumentation to create a transaction, you can add data to t | |||
|
|
|||
| Whatever a transaction's sampling decision, that decision will be passed to its child spans and from there to any transactions they subsequently cause in other services. | |||
|
|
|||
| (See <PlatformLink to="/usage/distributed-tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
There was a problem hiding this comment.
Suggested change
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |
| (See <PlatformLink to="/tracing/">Tracing</PlatformLink> for more about how that propagation is done.) |
| @@ -22,7 +22,7 @@ The Cocoa SDK uses [swizzling](https://nshipster.com/method-swizzling/) to provi | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">Auto instrumentation for HTTP requests</PlatformLink> | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">Auto instrumentation for File I/O operations</PlatformLink> | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">Auto instrumentation for Core Data operations</PlatformLink> | |||
| - <PlatformLink to="/usage/distributed-tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |||
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |||
There was a problem hiding this comment.
Suggested change
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for tracing</PlatformLink> |
| @@ -12,7 +12,7 @@ The Cocoa SDK uses [swizzling](https://nshipster.com/method-swizzling/) to provi | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#network-tracking">Auto instrumentation for HTTP requests</PlatformLink> | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#file-io-tracing">Auto instrumentation for File I/O operations</PlatformLink> | |||
| - <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#core-data-tracing">Auto instrumentation for Core Data operations</PlatformLink> | |||
| - <PlatformLink to="/usage/distributed-tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |||
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |||
There was a problem hiding this comment.
Suggested change
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for distributed tracing</PlatformLink> | |
| - <PlatformLink to="/tracing/">Automatically added sentry-trace header to HTTP requests for tracing</PlatformLink> |
| @@ -72,7 +72,7 @@ When using custom instrumentation to create a transaction, you can add data to t | |||
|
|
|||
| Whatever a transaction's sampling decision, that decision will be passed to its child spans and from there to any transactions they subsequently cause in other services. | |||
|
|
|||
| (See <PlatformLink to="/usage/distributed-tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
There was a problem hiding this comment.
Suggested change
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |
| (See <PlatformLink to="/tracing/">Tracing</PlatformLink> for more about how that propagation is done.) |
| @@ -72,7 +72,7 @@ When using custom instrumentation to create a transaction, you can add data to t | |||
|
|
|||
| Whatever a transaction's sampling decision, that decision will be passed to its child spans and from there to any transactions they subsequently cause in other services. | |||
|
|
|||
| (See <PlatformLink to="/usage/distributed-tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |||
There was a problem hiding this comment.
Suggested change
| (See <PlatformLink to="/tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.) | |
| (See <PlatformLink to="/tracing/">Tracing</PlatformLink> for more about how that propagation is done.) |
|
Sorry, I changed my mind on this - at least dropping the "Distributed" part. Some evidence there are lot of pages outside of docs that still describe it as such https://www.google.com/search?q=sentry+distributed+tracing&oq=sentry+distributed+tracing&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIGCAEQRRhAMgYIAhBFGDwyBggDEEUYPDIGCAQQRRg80gEINTMwN2owa
Also most of our competitors call it "Distributed Tracing" |
|
This PR will be replaced by #9604 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
ref: #9570