Package io.opentelemetry.sdk.trace.samplers

Class ParentBasedSampler

java.lang.Object

io.opentelemetry.sdk.trace.samplers.ParentBasedSampler

All Implemented Interfaces:

Sampler

@Immutable
public class ParentBasedSampler
extends Object
implements Sampler

A Sampler that uses the sampled flag of the parent Span, if present. If the span has no parent, this Sampler will use the "root" sampler that it is built with. See documentation on the ParentBasedSampler.Builder methods for the details on the various configurable options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParentBasedSampler.Builder	A builder for creating ParentBased sampler instances.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Returns the description of this Sampler.
int	hashCode()
SamplingResult	shouldSample(io.opentelemetry.context.Context parentContext, String traceId, String name, io.opentelemetry.api.trace.Span.Kind spanKind, io.opentelemetry.api.common.Attributes attributes, List<SpanData.Link> parentLinks)	Called during Span creation to make a sampling samplingResult.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

shouldSample

public SamplingResult shouldSample(io.opentelemetry.context.Context parentContext,
                                   String traceId,
                                   String name,
                                   io.opentelemetry.api.trace.Span.Kind spanKind,
                                   io.opentelemetry.api.common.Attributes attributes,
                                   List<SpanData.Link> parentLinks)

Description copied from interface: Sampler

Called during Span creation to make a sampling samplingResult.

Specified by:

shouldSample in interface Sampler

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 - Attributes associated with the span.

parentLinks - the parentLinks associated with the new Span.

Returns:

sampling samplingResult whether span should be sampled or not.

getDescription

public String getDescription()

Description copied from interface: Sampler

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

Example: "TraceIdRatioBased{0.000100}"

Specified by:

getDescription in interface Sampler

Returns:

the description of this Sampler.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object