Package io.opentelemetry.sdk.extension.incubator.trace.samplers

Interface ComposableSampler

public interface ComposableSampler

A sampler that can be composed to make a final sampling decision.

Method Summary

Modifier and Type	Method	Description
static ComposableSampler	alwaysOff()	Returns a ComposableSampler that does not sample any span.
static ComposableSampler	alwaysOn()	Returns a ComposableSampler that samples all spans.
static ComposableSampler	annotating(ComposableSampler sampler, io.opentelemetry.api.common.Attributes attributes)	Returns a ComposableSampler that adds the given Attributes to all sampled spans.
String	getDescription()	Returns a description of the sampler implementation.
SamplingIntent	getSamplingIntent(io.opentelemetry.context.Context parentContext, String traceId, String name, io.opentelemetry.api.trace.SpanKind spanKind, io.opentelemetry.api.common.Attributes attributes, List<io.opentelemetry.sdk.trace.data.LinkData> parentLinks)	Returns the SamplingIntent to use to make a sampling decision.
static ComposableSampler	parentThreshold(ComposableSampler rootSampler)	Returns a ComposableSampler that respects the sampling decision of the parent span or falls back to the given sampler if it is a root span.
static ComposableSampler	probability(double ratio)	Returns a ComposableSampler that samples each span with a fixed ratio.
static ComposableRuleBasedSamplerBuilder	ruleBasedBuilder()	Returns a ComposableRuleBasedSamplerBuilder to create a composable rule-based sampler.

Method Details

alwaysOff

static ComposableSampler alwaysOff()

Returns a ComposableSampler that does not sample any span.

alwaysOn

static ComposableSampler alwaysOn()

Returns a ComposableSampler that samples all spans.

probability

static ComposableSampler probability(double ratio)

Returns a ComposableSampler that samples each span with a fixed ratio.

parentThreshold

static ComposableSampler parentThreshold(ComposableSampler rootSampler)

Returns a ComposableSampler that respects the sampling decision of the parent span or falls back to the given sampler if it is a root span.

ruleBasedBuilder

static ComposableRuleBasedSamplerBuilder ruleBasedBuilder()

Returns a ComposableRuleBasedSamplerBuilder to create a composable rule-based sampler. Rules will be tested in order, and the first to match will have its ComposableSampler used for a sampling decision. If no rule matches, the span will be dropped.

annotating

static ComposableSampler annotating(ComposableSampler sampler,
 io.opentelemetry.api.common.Attributes attributes)

Returns a ComposableSampler that adds the given Attributes to all sampled spans.

getSamplingIntent

SamplingIntent getSamplingIntent(io.opentelemetry.context.Context parentContext,
 String traceId,
 String name,
 io.opentelemetry.api.trace.SpanKind spanKind,
 io.opentelemetry.api.common.Attributes attributes,
 List<io.opentelemetry.sdk.trace.data.LinkData> parentLinks)

Returns the SamplingIntent to use to make a sampling decision.

getDescription

String getDescription()

Returns a description of the sampler implementation.