[DOC] Update and expand profiling types doc #3659
Conversation
knylander-grafana
added
the
type/docs
knylander-grafana
added
the
backport release/v1.9
|
This PR must be merged before a backport PR will be created. |
There was a problem hiding this comment.
I wonder if we want to explain a common friction point we have with a lot of customers who use span profiles. That is: Span profiling is not effective on short spans (<20ms) as there are only a couple sampled profiles. This results in a statistically inaccurate profile.
Ideally we should only trust span profiles that are maybe 100ms or longer. (Not sure on the specific threshold, perhaps the rest of the team can weigh in here)
There was a problem hiding this comment.
I've added an admonition noting that span profiling is not effective on short spans, using your wording. I didn't put a comment about the specific size to trust. We can always update this information.
There was a problem hiding this comment.
Ryan weighed in with a suggested edit, which I've added.
Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com>
Co-authored-by: Marc Sanmiquel <marcsanmiquel@gmail.com>
* Update and expand profiling types doc * Fix doc validator issues * Apply suggestions from code review Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> * Share profile types list * Updates from Bryan's review * Apply suggestions from code review Co-authored-by: Marc Sanmiquel <marcsanmiquel@gmail.com> * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> Co-authored-by: Marc Sanmiquel <marcsanmiquel@gmail.com> (cherry picked from commit 82a1901)
Updates and expands the supported profiling content.
Fixes: #3259