io.zipkin

Class Sampler

java.lang.Object

io.zipkin.Sampler

Direct Known Subclasses:

Sampler.ProbabilisticSampler

public abstract class Sampler
extends Object

Sampler is responsible for deciding if a particular trace should be "sampled", i.e. recorded in permanent storage.

Zipkin v1 uses before-the-fact sampling. This means that the decision to keep or drop the trace is made before any work is measured, or annotations are added. As such, the input parameter to zipkin v1 samplers is the trace ID (64-bit random number).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sampler.ProbabilisticSampler Accepts a percentage of trace ids by comparing their absolute value against a boundary.

Constructor Summary

Constructors

Constructor and Description
Sampler()

Method Summary

Modifier and Type	Method and Description
static Sampler	create(float rate) Returns a sampler, given a rate expressed as a percentage.
abstract boolean	isSampled(long traceId) Returns true if the trace ID should be recorded.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sampler

public Sampler()

Method Detail

isSampled

public abstract boolean isSampled(long traceId)

Returns true if the trace ID should be recorded.

create

public static Sampler create(float rate)

Returns a sampler, given a rate expressed as a percentage.

Parameters:

rate - minimum sample rate is 0.0001, or 0.01% of traces

See Also:

Sampler.ProbabilisticSampler