Document tracing issues related to ingestion model #382
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/develop/BacxBbYohnrw9WCvCRrF7VVc1QrS |
|
Starting with an example trace to explain the current ingestion model and how it differs from OpenTelemetry and others. Next, will go into specific issues. |
The numbers seemed fine when there were just 2 items, but when there will be several items under "span ingestion model", numbering all of them is silly and error prone.
@AbhiPrasad I saw this suggestion, but not sure how to fit it in the current document. |
Co-authored-by: Abhijeet Prasad <[email protected]>
lobsterkatie
left a comment
lobsterkatie
left a comment
There was a problem hiding this comment.
This is great, @rhcarvalho! 🙂
I've made a whole boatload of suggestions, but the majority of them are just copy editing - in descending LOGAF order, they consist of grammar fixes, changes to make the language more idiomatic, and generalized wordsmithing. In the places where I made larger changes to sentences, I tried to explain why, but also obviously feel free to ask if anything is unclear.
There are also a small handful of legit questions or comments, but overall I think the content here is really good!
|
|
||
| The implementation of the actual `trace` function is relatively simple (see [a PR which has an example implementation](https://github.com/getsentry/sentry-javascript/pull/3697/files#diff-f5bf6e0cdf7709e5675fcdc3b4ff254dd68f3c9d1a399c8751e0fa1846fa85dbR158)), however, knowing what is the current span in async code and global integrations is a challenge yet to be overcome. | ||
|
|
||
| The following two examples synthesize the scope propagation issues. |
There was a problem hiding this comment.
| The following two examples synthesize the scope propagation issues. | |
| The following two examples demonstrate the scope propagation issues. |
There was a problem hiding this comment.
Hmm here I meant a bit more than just "demonstrate". I used "synthesize" because, I my view at the time, the two examples fully cover and define the issues.
But perhaps we don't need such precision, and "demonstrate" is a simpler word, possibly easier to understand, without much loss in meaning.
There was a problem hiding this comment.
Hmmm - I'm trying to come up with a better word than "demonstrate," then.
I replaced "synthesize" because it needs something or someone to be the subject, doing the synthesis of the examples/ideas/etc (the object) into some coherent whole. What about "encapsulate?"
|
|
||
| We have learned a lot with the current tracing implementation at Sentry. This document is an attempt to capture many of the known limitations to serve as basis for future improvement. | ||
|
|
||
| Tracing is a complex subject, and taming that complexity is no easy feat. |
There was a problem hiding this comment.
I really like this sentence. I feel like I should steal it for the top of the nextjs SDK docs. "Next.js is a complex framework, and taming that complexity is no easy feat. We're working on it - be patient."
|
Thanks for the review, @lobsterkatie! |
Co-authored-by: Katie Byers <[email protected]>
…mance-evolution-issues-ingestion-model
|
All feedback applied, thanks again @lobsterkatie! |
|
@jan-auer or @mitsuhiko could you give a quick pass on this before we merge it? I'd like to get your agreement at least with regards to the high level issues documented here. |
vladanpaunovic
left a comment
vladanpaunovic
left a comment
There was a problem hiding this comment.
Great post @rhcarvalho! Thanks to this documentation I learned so much more about how our spans work. Thank you.
|
Considering summer and this topic has been open and shared with relevant folks for some time now, we're opting to merge it as is and any further feedback or concerns can be addressed through issues or follow up PRs. |
1 similar comment
|
Considering summer and this topic has been open and shared with relevant folks for some time now, we're opting to merge it as is and any further feedback or concerns can be addressed through issues or follow up PRs. |
rhcarvalho
deleted the
rhcarvalho/performance-evolution-issues-ingestion-model
branch
Follows up on #356 and #381.
Documents the current Sentry span ingestion model, compare the model to alternatives, lists and explains several identified issues and wraps up with a summary for all identified issues (scope propagation and ingestion model).