Skip to content

feat(opentelemetry): Expose sampling helper #12674

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

Merged
merged 3 commits into from
Jul 3, 2024
Merged

feat(opentelemetry): Expose sampling helper #12674

merged 3 commits into from
Jul 3, 2024

Conversation

mydea
Copy link
Member

@mydea mydea commented Jun 27, 2024

When users want to use a custom sampler, they can use these new helpers to still have sentry working nicely with whatever they decide to do in there.

For e.g. trace propagation etc. to work correctly with Sentry, we need to attach some things to trace state etc. These helpers encapsulate this for the user, while still allowing them to decide however they want if the span should be sampled or not.

This was brought up here: #12191 (reply in thread)

@mydea mydea requested review from lforst, AbhiPrasad and chargome June 27, 2024 11:25
@mydea mydea self-assigned this Jun 27, 2024
Copy link
Contributor

github-actions bot commented Jun 27, 2024

size-limit report 📦

Path Size
@sentry/browser 22.22 KB (0%)
@sentry/browser (incl. Tracing) 33.38 KB (0%)
@sentry/browser (incl. Tracing, Replay) 69.12 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.45 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas) 73.18 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback) 85.8 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 87.66 KB (0%)
@sentry/browser (incl. metrics) 26.5 KB (0%)
@sentry/browser (incl. Feedback) 38.86 KB (0%)
@sentry/browser (incl. sendFeedback) 26.84 KB (0%)
@sentry/browser (incl. FeedbackAsync) 31.45 KB (0%)
@sentry/react 24.97 KB (0%)
@sentry/react (incl. Tracing) 36.43 KB (0%)
@sentry/vue 26.33 KB (0%)
@sentry/vue (incl. Tracing) 35.24 KB (0%)
@sentry/svelte 22.36 KB (0%)
CDN Bundle 23.42 KB (0%)
CDN Bundle (incl. Tracing) 35.12 KB (0%)
CDN Bundle (incl. Tracing, Replay) 69.22 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) 74.41 KB (0%)
CDN Bundle - uncompressed 68.8 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed 103.82 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed 214.21 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 226.92 KB (0%)
@sentry/nextjs (client) 36.3 KB (0%)
@sentry/sveltekit (client) 34.02 KB (0%)
@sentry/node 130.68 KB (+0.06% 🔺)
@sentry/node - without tracing 91.71 KB (+0.08% 🔺)
@sentry/aws-serverless 116.88 KB (+0.06% 🔺)

@tnolet
Copy link

tnolet commented Jul 2, 2024

@mydea do you have any idea when this patch PR might land in the main branch and be published?

@mydea
Copy link
Member Author

mydea commented Jul 2, 2024

Once this is reviewed and merged, it will go into the next release - probably later this week or early next week it should be out!

SentrySampler,
sentrySamplerNoDecision,
sentrySamplerNotSampled,
sentrySamplerSampled,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Couldn't we expose a single method that takes in SamplingDecision from @opentelemetry/sdk-trace-base or similar?

sentrySampler({
  decision, // SamplingDecision enum
  context,
  spanAttributes,
})

It feels like a lot of overhead for us to export three different methods, and to me it feels better to expose the underlying enum being used.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that sounds like a good idea to me! 👍 will adjust this.

mydea added 3 commits July 2, 2024 16:34
When users want to use a custom sampler, they can use these new helpers to still have sentry working nicely with whatever they decide to do in there.

For e.g. trace propagation etc. to work correctly with Sentry, we need to attach some things to trace state etc. These helpers encapsulate this for the user, while still allowing them to decide however they want if the span should be sampled or not.
@mydea
Copy link
Member Author

mydea commented Jul 2, 2024

Updated this to instead only export wrapSamplingDecision:

return wrapSamplingDecision({ decision: SamplingDecision.NOT_RECORD, context, spanAttributes });

@mydea mydea force-pushed the fn/otel-sampler branch from d7c937a to 235620f Compare July 2, 2024 14:43
@mydea mydea changed the title feat(opentelemetry): Expose sampling helpers feat(opentelemetry): Expose sampling helper Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants