Skip to content

Add declarative support for composable parent threshold sampler #7941

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.

Sign up for GitHub

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
jack-berg merged 4 commits into from
Dec 29, 2025
Merged

Add declarative support for composable parent threshold sampler #7941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9455f8a
Add declarative support for composable parent threshold sampler
jack-berg Dec 29, 2025
e6f162f
Add failure test
jack-berg Dec 29, 2025
5547c97
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Dec 29, 2025
01686cb
merge conflict
jack-berg Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk-extensions/incubator/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ tasks.getByName("compileJava").dependsOn(deleteJs2pTmp)
tasks.getByName("sourcesJar").dependsOn(deleteJs2pTmp, buildGraalVmReflectionJson)
tasks.getByName("jar").dependsOn(deleteJs2pTmp, buildGraalVmReflectionJson)
tasks.getByName("javadoc").dependsOn(buildGraalVmReflectionJson)
tasks.getByName("compileTestJava").dependsOn(buildGraalVmReflectionJson)

// Exclude jsonschema2pojo generated sources from checkstyle
tasks.named<Checkstyle>("checkstyleMain") {
Expand Down
8 changes: 8 additions & 0 deletions ...in/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ComposableSamplerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package io.opentelemetry.sdk.extension.incubator.fileconfig;

import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableParentThresholdSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableProbabilitySamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableRuleBasedSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableSamplerModel;
Expand Down Expand Up @@ -43,6 +44,13 @@ public ComposableSampler create(
if (ruleBased != null) {
return ComposableRuleBasedSamplerFactory.getInstance().create(ruleBased, context);
}
ExperimentalComposableParentThresholdSamplerModel parentThreshold = model.getParentThreshold();
if (parentThreshold != null) {
ExperimentalComposableSamplerModel rootModel =
FileConfigUtil.requireNonNull(parentThreshold.getRoot(), "parent threshold sampler root");
ComposableSampler rootSampler = INSTANCE.create(rootModel, context);
return ComposableSampler.parentThreshold(rootSampler);
}
Map.Entry<String, ?> keyValue =
FileConfigUtil.getSingletonMapEntry(model.getAdditionalProperties(), "composable sampler");
return context.loadComponent(ComposableSampler.class, keyValue.getKey(), keyValue.getValue());
Expand Down
100 changes: 72 additions & 28 deletions ...src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/SamplerFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,21 @@
import io.opentelemetry.sdk.extension.incubator.fileconfig.component.SamplerComponentProvider;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AlwaysOffSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AlwaysOnSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableAlwaysOffSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableAlwaysOnSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableParentThresholdSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableProbabilitySamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableRuleBasedSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalComposableSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalJaegerRemoteSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ParentBasedSamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SamplerModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SamplerPropertyModel;
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TraceIdRatioBasedSamplerModel;
import io.opentelemetry.sdk.extension.incubator.trace.samplers.ComposableSampler;
import io.opentelemetry.sdk.extension.incubator.trace.samplers.CompositeSampler;
import io.opentelemetry.sdk.extension.trace.jaeger.sampler.JaegerRemoteSampler;
import io.opentelemetry.sdk.trace.samplers.Sampler;
import java.io.Closeable;
import java.time.Duration;
import java.util.ArrayList;
Expand All @@ -45,16 +54,14 @@ class SamplerFactoryTest {

@ParameterizedTest
@MethodSource("createArguments")
void create(
@Nullable SamplerModel model, io.opentelemetry.sdk.trace.samplers.Sampler expectedSampler) {
void create(@Nullable SamplerModel model, Sampler expectedSampler) {
// Some samplers like JaegerRemoteSampler are Closeable - ensure these get cleaned up
if (expectedSampler instanceof Closeable) {
cleanup.addCloseable((Closeable) expectedSampler);
}

List<Closeable> closeables = new ArrayList<>();
io.opentelemetry.sdk.trace.samplers.Sampler sampler =
SamplerFactory.getInstance().create(model, context);
Sampler sampler = SamplerFactory.getInstance().create(model, context);
cleanup.addCloseables(closeables);

assertThat(sampler.toString()).isEqualTo(expectedSampler.toString());
Expand All @@ -63,22 +70,19 @@ void create(
private static Stream<Arguments> createArguments() {
return Stream.of(
Arguments.of(
new SamplerModel().withAlwaysOn(new AlwaysOnSamplerModel()),
io.opentelemetry.sdk.trace.samplers.Sampler.alwaysOn()),
new SamplerModel().withAlwaysOn(new AlwaysOnSamplerModel()), Sampler.alwaysOn()),
Arguments.of(
new SamplerModel().withAlwaysOff(new AlwaysOffSamplerModel()),
io.opentelemetry.sdk.trace.samplers.Sampler.alwaysOff()),
new SamplerModel().withAlwaysOff(new AlwaysOffSamplerModel()), Sampler.alwaysOff()),
Arguments.of(
new SamplerModel().withTraceIdRatioBased(new TraceIdRatioBasedSamplerModel()),
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(1.0d)),
Sampler.traceIdRatioBased(1.0d)),
Arguments.of(
new SamplerModel()
.withTraceIdRatioBased(new TraceIdRatioBasedSamplerModel().withRatio(0.5d)),
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.5)),
Sampler.traceIdRatioBased(0.5)),
Arguments.of(
new SamplerModel().withParentBased(new ParentBasedSamplerModel()),
io.opentelemetry.sdk.trace.samplers.Sampler.parentBased(
io.opentelemetry.sdk.trace.samplers.Sampler.alwaysOn())),
Sampler.parentBased(Sampler.alwaysOn())),
Arguments.of(
new SamplerModel()
.withParentBased(
Expand All @@ -103,16 +107,11 @@ private static Stream<Arguments> createArguments() {
new SamplerModel()
.withTraceIdRatioBased(
new TraceIdRatioBasedSamplerModel().withRatio(0.5d)))),
io.opentelemetry.sdk.trace.samplers.Sampler.parentBasedBuilder(
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.1d))
.setRemoteParentSampled(
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.2d))
.setRemoteParentNotSampled(
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.3d))
.setLocalParentSampled(
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.4d))
.setLocalParentNotSampled(
io.opentelemetry.sdk.trace.samplers.Sampler.traceIdRatioBased(0.5d))
Sampler.parentBasedBuilder(Sampler.traceIdRatioBased(0.1d))
.setRemoteParentSampled(Sampler.traceIdRatioBased(0.2d))
.setRemoteParentNotSampled(Sampler.traceIdRatioBased(0.3d))
.setLocalParentSampled(Sampler.traceIdRatioBased(0.4d))
.setLocalParentNotSampled(Sampler.traceIdRatioBased(0.5d))
.build()),
Arguments.of(
new SamplerModel()
Expand All @@ -125,17 +124,55 @@ private static Stream<Arguments> createArguments() {
JaegerRemoteSampler.builder()
.setEndpoint("http://jaeger-remote-endpoint")
.setPollingInterval(Duration.ofSeconds(10))
.setInitialSampler(io.opentelemetry.sdk.trace.samplers.Sampler.alwaysOff())
.build()));
.setInitialSampler(Sampler.alwaysOff())
.build()),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withAlwaysOn(new ExperimentalComposableAlwaysOnSamplerModel())),
CompositeSampler.wrap(ComposableSampler.alwaysOn())),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withAlwaysOff(new ExperimentalComposableAlwaysOffSamplerModel())),
CompositeSampler.wrap(ComposableSampler.alwaysOff())),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withProbability(
new ExperimentalComposableProbabilitySamplerModel().withRatio(0.5))),
CompositeSampler.wrap(ComposableSampler.probability(0.5))),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withRuleBased(new ExperimentalComposableRuleBasedSamplerModel())),
CompositeSampler.wrap(ComposableSampler.ruleBasedBuilder().build())),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withParentThreshold(
new ExperimentalComposableParentThresholdSamplerModel()
.withRoot(
new ExperimentalComposableSamplerModel()
.withAlwaysOn(
new ExperimentalComposableAlwaysOnSamplerModel())))),
CompositeSampler.wrap(
ComposableSampler.parentThreshold(ComposableSampler.alwaysOn()))));
}

@ParameterizedTest
@MethodSource("createInvalidArguments")
void createInvalid(SamplerModel model, String expectedMessage) {
assertThatThrownBy(() -> SamplerFactory.getInstance().create(model, context))
.isInstanceOf(DeclarativeConfigException.class)
.cause()
.hasMessage(expectedMessage);
.extracting(throwable -> throwable.getCause() == null ? throwable : throwable.getCause())
.extracting(Throwable::getMessage)
.isEqualTo(expectedMessage);
}

private static Stream<Arguments> createInvalidArguments() {
Expand All @@ -149,7 +186,14 @@ private static Stream<Arguments> createInvalidArguments() {
.withJaegerRemoteDevelopment(
new ExperimentalJaegerRemoteSamplerModel()
.withEndpoint("http://jaeger-remote-endpoint")),
"jaeger remote sampler initial_sampler is required"));
"jaeger remote sampler initial_sampler is required"),
Arguments.of(
new SamplerModel()
.withCompositeDevelopment(
new ExperimentalComposableSamplerModel()
.withParentThreshold(
new ExperimentalComposableParentThresholdSamplerModel())),
"parent threshold sampler root is required but is null"));
}

@Test
Expand All @@ -174,7 +218,7 @@ void create_SpiExporter_Unknown() {

@Test
void create_SpiExporter_Valid() {
io.opentelemetry.sdk.trace.samplers.Sampler sampler =
Sampler sampler =
SamplerFactory.getInstance()
.create(
new SamplerModel()
Expand Down
Loading