Package io.opencensus.trace
Class Sampler
java.lang.Object
io.opencensus.trace.Sampler
- Direct Known Subclasses:
AlwaysSampleSampler
,NeverSampleSampler
,ProbabilitySampler
Sampler is used to make decisions on
Span
sampling.- Since:
- 0.5
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract String
Returns the description of thisSampler
.abstract boolean
shouldSample
(SpanContext parentContext, Boolean hasRemoteParent, TraceId traceId, SpanId spanId, String name, List<Span> parentLinks) Called duringSpan
creation to make a sampling decision.
-
Constructor Details
-
Sampler
public Sampler()
-
-
Method Details
-
shouldSample
public abstract boolean shouldSample(@Nullable SpanContext parentContext, @Nullable Boolean hasRemoteParent, TraceId traceId, SpanId spanId, String name, List<Span> parentLinks) Called duringSpan
creation to make a sampling decision.- Parameters:
parentContext
- the parent span'sSpanContext
.null
if this is a root span.hasRemoteParent
-true
if the parentSpan
is remote.null
if this is a root span.traceId
- theTraceId
for the newSpan
. This will be identical to that in the parentContext, unless this is a root span.spanId
- theSpanId
for the newSpan
.name
- the name of the newSpan
.parentLinks
- the parentLinks associated with the newSpan
.- Returns:
true
if theSpan
is sampled.- Since:
- 0.5
-
getDescription
Returns the description of thisSampler
. This may be displayed on debug pages or in the logs.Example: "ProbabilitySampler{0.000100}"
- Returns:
- the description of this
Sampler
. - Since:
- 0.6
-