-
Notifications
You must be signed in to change notification settings - Fork 179
[dynamic control] Add delegating sampler implementation #2607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+147
−0
Merged
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
42c7b8a
delegating sampler implementation
jackshirazi 9421f73
null handling feedback
jackshirazi 0689d67
Update dynamic-control/src/main/java/io/opentelemetry/contrib/dynamic…
jackshirazi f8b3801
Update dynamic-control/src/main/java/io/opentelemetry/contrib/dynamic…
jackshirazi 4997eeb
Update dynamic-control/src/main/java/io/opentelemetry/contrib/dynamic…
jackshirazi 7cca122
Update dynamic-control/src/main/java/io/opentelemetry/contrib/dynamic…
jackshirazi df6f4a8
spotless
jackshirazi a944929
test added
jackshirazi 9db3bc9
Update dynamic-control/src/main/java/io/opentelemetry/contrib/dynamic…
jackshirazi 277f047
much better to use volatile per trask's suggestion
jackshirazi 1189626
merge conflict
jackshirazi 936dddf
spotless
jackshirazi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
90 changes: 90 additions & 0 deletions
90
...mic-control/src/main/java/io/opentelemetry/contrib/dynamic/sampler/DelegatingSampler.java
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,90 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.contrib.dynamic.sampler; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| 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 java.util.List; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * A {@link Sampler} implementation that delegates sampling decisions to another {@link Sampler} | ||
| * instance held in an {@link AtomicReference}. This allows the effective sampling strategy to be | ||
| * reconfigured at runtime without rebuilding the {@code SdkTracerProvider} or recreating | ||
| * instrumented components. | ||
| * | ||
| * <p>This class is thread-safe. All access to the current delegate sampler is performed through an | ||
| * {@link AtomicReference}, so sampling decisions and delegate updates may occur concurrently | ||
| * without additional synchronization. | ||
| * | ||
| * <p>The delegate sampler can be updated dynamically via {@link #setDelegate(Sampler)}. Passing | ||
| * {@code null} to {@code setDelegate} or the constructor will cause {@link Sampler#alwaysOn()} to | ||
| * be used as the fallback delegate. | ||
| */ | ||
| public class DelegatingSampler implements Sampler { | ||
|
|
||
| private final AtomicReference<Sampler> delegate; | ||
|
jackshirazi marked this conversation as resolved.
Outdated
|
||
|
|
||
|
jackshirazi marked this conversation as resolved.
|
||
| /** | ||
| * Creates a new {@link DelegatingSampler} with the given initial delegate. | ||
| * | ||
| * <p>If {@code initialDelegate} is {@code null}, {@link Sampler#alwaysOn()} will be used as the | ||
| * initial delegate. | ||
| * | ||
| * @param initialDelegate the initial {@link Sampler} to delegate to, or {@code null} to use | ||
| * {@link Sampler#alwaysOn()} by default | ||
| */ | ||
| public DelegatingSampler(@Nullable Sampler initialDelegate) { | ||
| this.delegate = | ||
| new AtomicReference<>(initialDelegate != null ? initialDelegate : Sampler.alwaysOn()); | ||
| } | ||
|
|
||
| public DelegatingSampler() { | ||
| this(Sampler.alwaysOn()); | ||
| } | ||
|
|
||
|
jackshirazi marked this conversation as resolved.
|
||
| /** | ||
| * Updates the delegate {@link Sampler} used by this {@code DelegatingSampler} at runtime. | ||
| * | ||
| * <p>If {@code sampler} is {@code null}, this method will instead use {@link Sampler#alwaysOn()} | ||
| * as the delegate. | ||
| * | ||
| * @param sampler the new delegate sampler to use, or {@code null} to fall back to {@link | ||
| * Sampler#alwaysOn()} | ||
| */ | ||
| public void setDelegate(@Nullable Sampler sampler) { | ||
| delegate.set(sampler != null ? sampler : Sampler.alwaysOn()); | ||
| } | ||
|
jackshirazi marked this conversation as resolved.
|
||
|
|
||
| @Override | ||
| // delegate AtomicReference is guaranteed to be non-null | ||
| @SuppressWarnings("NullAway") | ||
|
jackshirazi marked this conversation as resolved.
Outdated
|
||
| public SamplingResult shouldSample( | ||
| Context ctx, | ||
| String traceId, | ||
| String name, | ||
| SpanKind kind, | ||
| Attributes attrs, | ||
| List<LinkData> links) { | ||
| return delegate.get().shouldSample(ctx, traceId, name, kind, attrs, links); | ||
|
jackshirazi marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| @Override | ||
| @SuppressWarnings("NullAway") | ||
| public String getDescription() { | ||
| return "delegating/" + delegate.get().getDescription(); | ||
| } | ||
|
jackshirazi marked this conversation as resolved.
|
||
|
|
||
| @Override | ||
| public String toString() { | ||
| return getDescription(); | ||
| } | ||
|
jackshirazi marked this conversation as resolved.
Outdated
|
||
| } | ||
62 changes: 62 additions & 0 deletions
62
...control/src/test/java/io/opentelemetry/contrib/dynamic/sampler/DelegatingSamplerTest.java
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,62 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.contrib.dynamic.sampler; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.trace.SpanKind; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.sdk.trace.samplers.Sampler; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingDecision; | ||
| import io.opentelemetry.sdk.trace.samplers.SamplingResult; | ||
| import java.util.Collections; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class DelegatingSamplerTest { | ||
|
|
||
| @Test | ||
| void defaultDelegateIsAlwaysOn() { | ||
| DelegatingSampler sampler = new DelegatingSampler(); | ||
|
|
||
| SamplingDecision decision = doSample(sampler); | ||
|
|
||
| assertThat(decision).isEqualTo(SamplingDecision.RECORD_AND_SAMPLE); | ||
| } | ||
|
|
||
| @Test | ||
| void setDelegateNullFallsBackToAlwaysOn() { | ||
| DelegatingSampler sampler = new DelegatingSampler(Sampler.alwaysOff()); | ||
|
|
||
| sampler.setDelegate(null); | ||
|
|
||
| SamplingDecision decision = doSample(sampler); | ||
| assertThat(decision).isEqualTo(SamplingDecision.RECORD_AND_SAMPLE); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldSampleDelegatesToCurrentSamplerAfterUpdate() { | ||
| DelegatingSampler sampler = new DelegatingSampler(Sampler.alwaysOff()); | ||
|
|
||
| assertThat(doSample(sampler)).isEqualTo(SamplingDecision.DROP); | ||
|
|
||
| sampler.setDelegate(Sampler.alwaysOn()); | ||
|
|
||
| assertThat(doSample(sampler)).isEqualTo(SamplingDecision.RECORD_AND_SAMPLE); | ||
| } | ||
|
|
||
| private static SamplingDecision doSample(DelegatingSampler sampler) { | ||
| SamplingResult result = | ||
| sampler.shouldSample( | ||
| Context.root(), | ||
| "00000000000000000000000000000001", | ||
| "test-span", | ||
| SpanKind.INTERNAL, | ||
| Attributes.empty(), | ||
| Collections.emptyList()); | ||
| return result.getDecision(); | ||
| } | ||
| } |
Oops, something went wrong.
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.