com.wavefront.sdk.entities.tracing.sampling

Class RateSampler

java.lang.Object

com.wavefront.sdk.entities.tracing.sampling.RateSampler

All Implemented Interfaces:

Sampler

public class RateSampler
extends Object
implements Sampler

Sampler that allows a certain probabilistic rate (between 0.0 and 1.0) of spans to be reported. Note: Sampling is performed per trace id. All spans for a sampled trace will be reported.

Author:

Vikram Raman

Constructor Summary

Constructors

Constructor and Description
RateSampler(double samplingRate) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isEarly() Whether this sampler performs early or head based sampling.
static boolean	sample(double samplingRate, long traceId) Gets whether a span should be allowed given it's sampling rate and trace id.
boolean	sample(String operationName, long traceId, long duration) Gets whether a span should be allowed given it's operation and trace id.
void	setSamplingRate(double samplingRate) Sets the sampling rate for this sampler.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateSampler

public RateSampler(double samplingRate)

Constructor.

Parameters:

samplingRate - a sampling rate between 0.0 and 1.0.

Method Detail

sample

public boolean sample(String operationName,
                      long traceId,
                      long duration)

Description copied from interface: Sampler

Gets whether a span should be allowed given it's operation and trace id.

Specified by:

sample in interface Sampler

Parameters:

operationName - The operation name of the span

traceId - The traceId of the span

duration - The duration of the span in milliseconds

Returns:

true if the span should be allowed, false otherwise

sample

public static boolean sample(double samplingRate,
                             long traceId)

Gets whether a span should be allowed given it's sampling rate and trace id.

Parameters:

samplingRate - The sampling rate between 0.0 and 1.0. of the span

traceId - The traceId of the span

Returns:

true if the span should be allowed, false otherwise

isEarly

public boolean isEarly()

Description copied from interface: Sampler

Whether this sampler performs early or head based sampling. Offers a non-binding hint for clients using the sampler.

Specified by:

isEarly in interface Sampler

Returns:

true for early sampling, false otherwise

setSamplingRate

public void setSamplingRate(double samplingRate)

Sets the sampling rate for this sampler.

Parameters:

samplingRate - the sampling rate between 0.0 and 1.0