io.opentelemetry.sdk.trace

Interface Sampler

@ThreadSafe
public interface Sampler

Sampler is used to make decisions on Span sampling.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Sampler.Decision A decision on whether a span should be recorded, recorded and sampled or dropped.
static interface	Sampler.SamplingResult Sampling result returned by Sampler#shouldSample(SpanContext, String, String, Kind, ReadableAttributes, List).

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of this Sampler.
Sampler.SamplingResult	shouldSample(io.opentelemetry.trace.SpanContext parentContext, String traceId, String name, io.opentelemetry.trace.Span.Kind spanKind, io.opentelemetry.common.ReadableAttributes attributes, List<SpanData.Link> parentLinks) Called during Span creation to make a sampling samplingResult.

Method Detail

shouldSample

Sampler.SamplingResult shouldSample(io.opentelemetry.trace.SpanContext parentContext,
                                    String traceId,
                                    String name,
                                    io.opentelemetry.trace.Span.Kind spanKind,
                                    io.opentelemetry.common.ReadableAttributes attributes,
                                    List<SpanData.Link> parentLinks)

Called during Span creation to make a sampling samplingResult.

Parameters:

parentContext - the parent span's SpanContext. This can be SpanContext.INVALID if this is a root span.

traceId - the TraceId for the new Span. This will be identical to that in the parentContext, unless this is a root span.

name - the name of the new Span.

spanKind - the Span.Kind of the Span.

attributes - ReadableAttributes associated with the span.

parentLinks - the parentLinks associated with the new Span.

Returns:

sampling samplingResult whether span should be sampled or not.

getDescription

String getDescription()

Returns the description of this Sampler. This may be displayed on debug pages or in the logs.

Example: "TraceIdRatioBased{0.000100}"

Returns:

the description of this Sampler.