feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat: Pass parentSampleRate to tracesSampler - #15024

Merged
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision
Jan 22, 2025
Merged

feat: Pass parentSampleRate to tracesSampler#15024
lforst merged 53 commits into
developfrom
lforst-parent-sampling-decision

Conversation

@lforst

@lforstlforst commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

Ref: #14932
Ref: getsentry/team-sdks#117

This PR mainly does 2 things:

  • Pick up the sample_rate from the DSC and pass it to the tracesSampler as parentSampleRate
  • "Unfreeze" or rather set the sample_rate for a DSC of a given span whenever we applied a sample rate to the span's root span. The sample_rate is equivalent to the sample rate the root span has been sampled with. This is to ensure that downstream services can reliably use the sample_rate in the DSC to pass it to the tracesSampler - like we do in this PR (kinda closing the loop).

@github-actions

github-actionsBot commented Jan 15, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.01 KB+0.14%+31 B 🔺
@sentry/browser - with treeshaking flags22.9 KB+0.13%+30 B 🔺
@sentry/browser (incl. Tracing)35.74 KB+0.17%+61 B 🔺
@sentry/browser (incl. Tracing, Replay)72.53 KB+0.09%+61 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags66.09 KB+0.1%+64 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.78 KB+0.09%+64 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.8 KB+0.08%+70 B 🔺
@sentry/browser (incl. Feedback)39.22 KB+0.08%+32 B 🔺
@sentry/browser (incl. sendFeedback)27.64 KB+0.1%+27 B 🔺
@sentry/browser (incl. FeedbackAsync)32.4 KB+0.1%+33 B 🔺
@sentry/react25.69 KB+0.12%+31 B 🔺
@sentry/react (incl. Tracing)38.52 KB+0.16%+61 B 🔺
@sentry/vue27.1 KB+0.22%+60 B 🔺
@sentry/vue (incl. Tracing)37.49 KB+0.15%+56 B 🔺
@sentry/svelte23.14 KB+0.14%+32 B 🔺
CDN Bundle24.4 KB+0.15%+35 B 🔺
CDN Bundle (incl. Tracing)36.04 KB+0.14%+49 B 🔺
CDN Bundle (incl. Tracing, Replay)70.66 KB+0.03%+18 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.82 KB+0.04%+29 B 🔺
CDN Bundle - uncompressed71.25 KB+0.13%+94 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.95 KB+0.13%+137 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.8 KB+0.07%+137 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.33 KB+0.06%+137 B 🔺
@sentry/nextjs (client)38.63 KB+0.16%+60 B 🔺
@sentry/sveltekit (client)36.27 KB+0.17%+62 B 🔺
@sentry/node156.28 KB+0.07%+111 B 🔺
@sentry/node - without tracing97.37 KB+0.06%+53 B 🔺
@sentry/aws-serverless106.83 KB+0.09%+97 B 🔺

View base workflow run

@codecov

codecovBot commented Jan 15, 2025

Copy link
Copy Markdown

❌ 2 Tests Failed:

Tests completedFailedPassedSkipped
6912689297
View the top 2 failed tests by shortest run time
propagation.test.tsPropagatestraceforoutgoinghttprequests
Stack Traces | 0.089s run time
propagation.test.ts:6:5Propagatestraceforoutgoinghttprequests
events.test.tsEventemitter
Stack Traces | 0.175s run time
events.test.ts:4:5Eventemitter

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

spans.forEach(span => {
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can drop this check (span.data &&), as span data is not optional anymore? 🤔

Comment threadpackages/core/src/envelope.ts Outdated

// This attribute is important for internal logic but should not leak into actual data
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmmm no strong feelings, but can we move this somewhere else than here? E.g. into sentrySpan (where we already delete the name attribute) and/or the span exporter (where we already clear some data that we do not want to send)? These feel like more correct places for this than the envelope, which should rather just send what it gets, IMHO.

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I put this here because there is no other really generic flow that runs for standalone spans. This is basically one-of logic. We already delete it in sentrySpan, but sentrySpan doesn't run for standalones, neither does the span exporter in browser. Do you have any other concrete ideas?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I could also just delete the line. We also seem to be sending other garbage attributes through standalones.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm, I see 🤔 you decide, it feels a bit "weird" to do this in envelope serialization step, but also OK to me!

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I know. For the lack of better placement I'll leave it. Removing it wouldn't be great since we'd just end up forgetting to do so. It's super easy to refactor once we flesh out standalone spans.

Comment threadpackages/core/src/tracing/dynamicSamplingContext.ts Outdated
const frozenDsc = (rootSpan as SpanWithMaybeDsc)[FROZEN_DSC_FIELD];
if (frozenDsc) {
return frozenDsc;
return applyTraceSampleRateOverrideToDsc(frozenDsc);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should this not be on the frozen DSC already in this scenario?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is effectively what this change is about. The sample_rate becomes "unfrozen" in certain situations so no matter what the dsc may be, the sample rate that was applied to the root span wins.


if (dscOnTraceState) {
return dscOnTraceState;
return applyTraceSampleRateOverrideToDsc(dscOnTraceState);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why is this not already on the frozen dsc from the trace state here?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Because for example when the sample rate returned from a tracesSampler is different than on the incoming DSC. The sample rate returned from the tracesSampler wins.

context: Context;
spanAttributes: SpanAttributes;
sampleRand?: number;
sampleRateOverride?: number;

@mydeamydeaJan 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is just the naming, but I am confused. This sounds to me as if we are overriding the used sample rate for this sampling decision? But if I read the comment below, I guess it means "propagate this sample rate to downstream spans"? Is this a correct interpretation? 😅

@lforstlforstJan 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

well here we are in wrapSamplingDecision, meaning that the sampling decision was already made. In this context, it kinda means what you wrote: Override the sampling decision on the DSC for everything downstream with this value, no matter what the DSC had as a sample_rate before. Do you have any suggestions?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Renamed it to shouldUpdateSampleRateOnDownstreamTrace for now.

Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@lforst
lforst requested a review from mydeaJanuary 20, 2025 13:18
@lforst

Copy link
Copy Markdown
ContributorAuthor

image

@lforst
lforst merged commit 5021a58 into developJan 22, 2025
@lforst
lforst deleted the lforst-parent-sampling-decision branch January 22, 2025 08:23
Sign up for freeto 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.

2 participants

@lforst@mydea