POTEL 11 - Move sampling logic into OTel Sampler #3462
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package io.sentry.opentelemetry; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.sentry.TracesSamplingDecision; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| @ApiStatus.Internal | ||
| public final class OtelSamplingUtil { | ||
|
|
||
| public static @Nullable TracesSamplingDecision extractSamplingDecisionOrDefault( | ||
| final @NotNull Attributes attributes) { | ||
| final @Nullable TracesSamplingDecision decision = extractSamplingDecision(attributes); | ||
| if (decision != null) { | ||
| return decision; | ||
| } else { | ||
| return new TracesSamplingDecision(false); | ||
| } | ||
| } | ||
|
|
||
| public static @Nullable TracesSamplingDecision extractSamplingDecision( | ||
| final @NotNull Attributes attributes) { | ||
| final @Nullable Boolean sampled = attributes.get(InternalSemanticAttributes.SAMPLED); | ||
| if (sampled != null) { | ||
| final @Nullable Double sampleRate = attributes.get(InternalSemanticAttributes.SAMPLE_RATE); | ||
| final @Nullable Boolean profileSampled = | ||
| attributes.get(InternalSemanticAttributes.PROFILE_SAMPLED); | ||
| final @Nullable Double profileSampleRate = | ||
| attributes.get(InternalSemanticAttributes.PROFILE_SAMPLE_RATE); | ||
|
|
||
| return new TracesSamplingDecision( | ||
| sampled, sampleRate, profileSampled == null ? false : profileSampled, profileSampleRate); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package io.sentry.opentelemetry; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.trace.Span; | ||
| import io.opentelemetry.api.trace.SpanKind; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.sdk.trace.data.LinkData; | ||
| import io.opentelemetry.sdk.trace.samplers.Sampler; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingResult; | ||
| import io.sentry.Baggage; | ||
| import io.sentry.IScopes; | ||
| import io.sentry.PropagationContext; | ||
| import io.sentry.SamplingContext; | ||
| import io.sentry.ScopesAdapter; | ||
| import io.sentry.SentryTraceHeader; | ||
| import io.sentry.SpanId; | ||
| import io.sentry.TracesSampler; | ||
| import io.sentry.TracesSamplingDecision; | ||
| import io.sentry.TransactionContext; | ||
| import io.sentry.protocol.SentryId; | ||
| import java.util.List; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public final class SentrySampler implements Sampler { | ||
|
|
||
| private final @NotNull SentryWeakSpanStorage spanStorage = SentryWeakSpanStorage.getInstance(); | ||
| private final @NotNull TracesSampler tracesSampler; | ||
|
|
||
| public SentrySampler(final @NotNull IScopes scopes) { | ||
| this.tracesSampler = new TracesSampler(scopes.getOptions()); | ||
| } | ||
|
|
||
| public SentrySampler() { | ||
| this(ScopesAdapter.getInstance()); | ||
| } | ||
|
|
||
| @Override | ||
| public SamplingResult shouldSample( | ||
| final @NotNull Context parentContext, | ||
| final @NotNull String traceId, | ||
| final @NotNull String name, | ||
| final @NotNull SpanKind spanKind, | ||
| final @NotNull Attributes attributes, | ||
| final @NotNull List<LinkData> parentLinks) { | ||
| // note: parentLinks seems to usually be empty | ||
| final @Nullable Span parentOtelSpan = Span.fromContextOrNull(parentContext); | ||
| final @Nullable OtelSpanWrapper parentSentrySpan = | ||
| parentOtelSpan != null ? spanStorage.getSentrySpan(parentOtelSpan.getSpanContext()) : null; | ||
|
|
||
| if (parentSentrySpan != null) { | ||
| return copyParentSentryDecision(parentSentrySpan); | ||
| } else { | ||
| final @Nullable TracesSamplingDecision samplingDecision = | ||
| OtelSamplingUtil.extractSamplingDecision(attributes); | ||
| if (samplingDecision != null) { | ||
| return new SentrySamplingResult(samplingDecision); | ||
| } else { | ||
| return handleRootOtelSpan(traceId, parentContext); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private @NotNull SentrySamplingResult handleRootOtelSpan( | ||
adinauer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| final @NotNull String traceId, final @NotNull Context parentContext) { | ||
| @Nullable Baggage baggage = null; | ||
| @Nullable | ||
| SentryTraceHeader sentryTraceHeader = parentContext.get(SentryOtelKeys.SENTRY_TRACE_KEY); | ||
| @Nullable Baggage baggageFromContext = parentContext.get(SentryOtelKeys.SENTRY_BAGGAGE_KEY); | ||
| if (sentryTraceHeader != null) { | ||
| baggage = baggageFromContext; | ||
| } | ||
|
|
||
| // there's no way to get the span id here, so we just use a random id for sampling | ||
| SpanId randomSpanId = new SpanId(); | ||
| final @NotNull PropagationContext propagationContext = | ||
| sentryTraceHeader == null | ||
| ? new PropagationContext(new SentryId(traceId), randomSpanId, null, baggage, null) | ||
| : PropagationContext.fromHeaders(sentryTraceHeader, baggage, randomSpanId); | ||
|
|
||
| final @NotNull TransactionContext transactionContext = | ||
| TransactionContext.fromPropagationContext(propagationContext); | ||
| final @NotNull TracesSamplingDecision sentryDecision = | ||
| tracesSampler.sample(new SamplingContext(transactionContext, null)); | ||
| return new SentrySamplingResult(sentryDecision); | ||
| } | ||
|
|
||
| private @NotNull SentrySamplingResult copyParentSentryDecision( | ||
| final @NotNull OtelSpanWrapper parentSentrySpan) { | ||
| final @Nullable TracesSamplingDecision parentSamplingDecision = | ||
| parentSentrySpan.getSamplingDecision(); | ||
| if (parentSamplingDecision != null) { | ||
| return new SentrySamplingResult(parentSamplingDecision); | ||
| } else { | ||
| // this should never happen and only serve to calm the compiler | ||
| // TODO [POTEL] log | ||
| return new SentrySamplingResult(new TracesSamplingDecision(true)); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "SentrySampler"; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package io.sentry.opentelemetry; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingDecision; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingResult; | ||
| import io.sentry.TracesSamplingDecision; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| public final class SentrySamplingResult implements SamplingResult { | ||
| private final TracesSamplingDecision sentryDecision; | ||
|
|
||
| public SentrySamplingResult(final @NotNull TracesSamplingDecision sentryDecision) { | ||
| this.sentryDecision = sentryDecision; | ||
| } | ||
|
|
||
| @Override | ||
| public SamplingDecision getDecision() { | ||
| if (sentryDecision.getSampled()) { | ||
| return SamplingDecision.RECORD_AND_SAMPLE; | ||
| } else { | ||
| return SamplingDecision.RECORD_ONLY; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Attributes getAttributes() { | ||
| return Attributes.builder() | ||
| .put(InternalSemanticAttributes.SAMPLED, sentryDecision.getSampled()) | ||
| .put(InternalSemanticAttributes.SAMPLE_RATE, sentryDecision.getSampleRate()) | ||
| .put(InternalSemanticAttributes.PROFILE_SAMPLED, sentryDecision.getProfileSampled()) | ||
| .put(InternalSemanticAttributes.PROFILE_SAMPLE_RATE, sentryDecision.getProfileSampleRate()) | ||
| .build(); | ||
| } | ||
|
|
||
| public TracesSamplingDecision getSentryDecision() { | ||
| return sentryDecision; | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.