-
Notifications
You must be signed in to change notification settings - Fork 329
Add ParentBasedAlwaysOnSampler as default sampler for OTLP trace export mode #10915
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
Open
mtoffl01
wants to merge
4
commits into
master
Choose a base branch
from
mtoff/otlp-export-sampling
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bb0ec0a
Introduce ParentBasedAlwaysOnSampler and make this the default sample…
mtoffl01 cee3a77
restore superfluous test file formatting back to master
mtoffl01 fc645af
Remove logic for actually enabling ParentBasedSampler
mtoffl01 f3bc0c8
migrate groovy -> junit
mtoffl01 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
24 changes: 24 additions & 0 deletions
24
dd-trace-core/src/main/java/datadog/trace/common/sampling/ParentBasedAlwaysOnSampler.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,24 @@ | ||
| package datadog.trace.common.sampling; | ||
|
|
||
| import datadog.trace.api.sampling.PrioritySampling; | ||
| import datadog.trace.api.sampling.SamplingMechanism; | ||
| import datadog.trace.core.CoreSpan; | ||
|
|
||
| /** | ||
| * Implements the OpenTelemetry {@code parentbased_always_on} sampler. | ||
| * | ||
| * <p>Root spans are always sampled. Child spans inherit the sampling decision from their parent, | ||
| * which is handled by the context propagation layer. | ||
| */ | ||
| public class ParentBasedAlwaysOnSampler implements Sampler, PrioritySampler { | ||
|
|
||
| @Override | ||
| public <T extends CoreSpan<T>> boolean sample(final T span) { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends CoreSpan<T>> void setSamplingPriority(final T span) { | ||
| span.setSamplingPriority(PrioritySampling.SAMPLER_KEEP, SamplingMechanism.DEFAULT); | ||
| } | ||
| } |
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
124 changes: 124 additions & 0 deletions
124
...race-core/src/test/java/datadog/trace/common/sampling/ParentBasedAlwaysOnSamplerTest.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,124 @@ | ||
| package datadog.trace.common.sampling; | ||
|
|
||
| import static datadog.trace.api.TracePropagationStyle.DATADOG; | ||
| import static datadog.trace.api.sampling.PrioritySampling.SAMPLER_DROP; | ||
| import static datadog.trace.api.sampling.PrioritySampling.SAMPLER_KEEP; | ||
| import static datadog.trace.api.sampling.PrioritySampling.USER_DROP; | ||
| import static datadog.trace.api.sampling.PrioritySampling.USER_KEEP; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import datadog.trace.api.DDTraceId; | ||
| import datadog.trace.common.writer.ListWriter; | ||
| import datadog.trace.common.writer.RemoteResponseListener; | ||
| import datadog.trace.core.CoreTracer; | ||
| import datadog.trace.core.DDSpan; | ||
| import datadog.trace.core.propagation.ExtractedContext; | ||
| import datadog.trace.core.propagation.PropagationTags; | ||
| import java.util.stream.Stream; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
|
|
||
| class ParentBasedAlwaysOnSamplerTest { | ||
|
|
||
| private final ListWriter writer = new ListWriter(); | ||
| private CoreTracer tracer; | ||
|
|
||
| @AfterEach | ||
| void tearDown() { | ||
| if (tracer != null) { | ||
| tracer.close(); | ||
| } | ||
| } | ||
|
|
||
| private CoreTracer buildTracer(ParentBasedAlwaysOnSampler sampler) { | ||
| tracer = CoreTracer.builder().writer(writer).sampler(sampler).build(); | ||
| return tracer; | ||
| } | ||
|
|
||
| @Test | ||
| void alwaysSamplesSpans() { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| CoreTracer tracer = buildTracer(sampler); | ||
|
|
||
| DDSpan span = (DDSpan) tracer.buildSpan("test").start(); | ||
| try { | ||
| assertTrue(sampler.sample(span)); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void setsSamplingPriorityToSamplerKeep() { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| CoreTracer tracer = buildTracer(sampler); | ||
|
|
||
| DDSpan span = (DDSpan) tracer.buildSpan("test").start(); | ||
| try { | ||
| sampler.setSamplingPriority(span); | ||
| assertEquals(SAMPLER_KEEP, span.getSamplingPriority()); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void childSpanInheritsSamplingPriorityFromLocalParent() { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| CoreTracer tracer = buildTracer(sampler); | ||
|
|
||
| DDSpan rootSpan = (DDSpan) tracer.buildSpan("root").start(); | ||
| sampler.setSamplingPriority(rootSpan); | ||
| DDSpan childSpan = (DDSpan) tracer.buildSpan("child").asChildOf(rootSpan.context()).start(); | ||
| try { | ||
| assertEquals(SAMPLER_KEEP, rootSpan.getSamplingPriority()); | ||
| assertEquals(SAMPLER_KEEP, childSpan.getSamplingPriority()); | ||
| } finally { | ||
| childSpan.finish(); | ||
| rootSpan.finish(); | ||
| } | ||
| } | ||
|
|
||
| static Stream<Arguments> childSpanInheritsSamplingDecisionFromRemoteParentArguments() { | ||
| return Stream.of( | ||
| Arguments.arguments("sampler keep", SAMPLER_KEEP), | ||
| Arguments.arguments("sampler drop", SAMPLER_DROP), | ||
| Arguments.arguments("user keep", USER_KEEP), | ||
| Arguments.arguments("user drop", USER_DROP)); | ||
| } | ||
|
Comment on lines
+87
to
+93
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice rework to JUnit! |
||
|
|
||
| @ParameterizedTest(name = "child span inherits sampling decision from remote parent: {0}") | ||
| @MethodSource("childSpanInheritsSamplingDecisionFromRemoteParentArguments") | ||
| void childSpanInheritsSamplingDecisionFromRemoteParent(String scenario, int parentPriority) { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| CoreTracer tracer = buildTracer(sampler); | ||
|
|
||
| ExtractedContext extractedContext = | ||
| new ExtractedContext( | ||
| DDTraceId.ONE, 2, parentPriority, null, PropagationTags.factory().empty(), DATADOG); | ||
|
|
||
| DDSpan span = (DDSpan) tracer.buildSpan("child").asChildOf(extractedContext).start(); | ||
| try { | ||
| assertEquals(parentPriority, span.getSamplingPriority()); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void isNotARemoteResponseListener() { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| assertFalse(sampler instanceof RemoteResponseListener); | ||
| } | ||
|
|
||
| @Test | ||
| void implementsPrioritySampler() { | ||
| ParentBasedAlwaysOnSampler sampler = new ParentBasedAlwaysOnSampler(); | ||
| assertTrue(sampler instanceof PrioritySampler); | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use
config.isTraceOtlpExporterEnabled()hereThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the plan 😉