Class NeverSampleSampler

java.lang.Object

io.opencensus.trace.Sampler

io.opencensus.trace.samplers.NeverSampleSampler

@Immutable
final class NeverSampleSampler
extends Sampler

Sampler that always makes a "no" decision on Span sampling.

Constructor Summary

Constructors

Constructor	Description
NeverSampleSampler()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of this Sampler.
boolean	shouldSample(SpanContext parentContext, Boolean hasRemoteParent, TraceId traceId, SpanId spanId, String name, List<Span> parentLinks)	Called during Span creation to make a sampling decision.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

NeverSampleSampler

NeverSampleSampler()

Method Details

shouldSample

public boolean shouldSample(@Nullable
 SpanContext parentContext,
 @Nullable
 Boolean hasRemoteParent,
 TraceId traceId,
 SpanId spanId,
 String name,
 List<Span> parentLinks)

Description copied from class: Sampler

Called during Span creation to make a sampling decision.

Specified by:

shouldSample in class Sampler

Parameters:

parentContext - the parent span's SpanContext. null if this is a root span.

hasRemoteParent - true if the parent Span is remote. null 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.

spanId - the SpanId for the new Span.

name - the name of the new Span.

parentLinks - the parentLinks associated with the new Span.

Returns:

true if the Span is sampled.

getDescription

public String getDescription()

Description copied from class: Sampler

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

Example: "ProbabilitySampler{0.000100}"

Specified by:

getDescription in class Sampler

Returns:

the description of this Sampler.

toString

public String toString()

Overrides:

toString in class Object