com.newrelic.agent.tracing.samplers

Class TraceRatioBasedSampler

java.lang.Object

com.newrelic.agent.tracing.samplers.TraceRatioBasedSampler

All Implemented Interfaces:

Sampler

public class TraceRatioBasedSampler
extends java.lang.Object
implements Sampler

Ratio based sampler that utilizes the hex encoded trace id string as a deterministic source of randomness.
The sampler is seeded with a float value that represents the sampling ratio target. The threshold (T) is calculated via:

     (Long.MAX_VALUE * traceRatio)
 

When the sampler is presented with the hex encoded trace id, a deterministic random value (R) is derived by extracting the last 8 bytes (16 characters) of the id and converting into a long value.
If this value is less than or equal to T, we return a priority of (Random Float Value of 0.0 - 1) + 1.0 which will mark this trace for sampling.

Constructor Summary

Constructors

Constructor and Description
TraceRatioBasedSampler(SamplerConfig samplerConfig) Construct a new TraceRatioBasedSampler with the desired ratio supplied as a float value in the SamplerConfig instance.

Method Summary

Modifier and Type	Method and Description
float	calculatePriority(Transaction tx, Granularity granularity) Calculate the priority of a trace.
java.lang.String	getDescription() Human-readable description of this sampler's name and important qualities.
long	getThreshold() Retrieve the current rejection threshold value
SamplerType	getType() Get the type of this Sampler

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.newrelic.agent.tracing.samplers.Sampler

isValidSamplingTarget, isValidTraceRatio, traceIdFromTransaction

Constructor Detail

TraceRatioBasedSampler

public TraceRatioBasedSampler(SamplerConfig samplerConfig)

Construct a new TraceRatioBasedSampler with the desired ratio supplied as a float value in the SamplerConfig instance.

Parameters:

samplerConfig - the agent's finalized sampler configuration

Method Detail

calculatePriority

public float calculatePriority(Transaction tx,
                               Granularity granularity)

Description copied from interface: Sampler

Calculate the priority of a trace. The value returned must be in the range of 0.0f - 2.0f.

Specified by:

calculatePriority in interface Sampler

Parameters:

tx - the transaction to calculate the priority for

Returns:

a priority value between 0.0f - 2.0f, inclusive

getType

public SamplerType getType()

Description copied from interface: Sampler

Get the type of this Sampler

Specified by:

getType in interface Sampler

Returns:

the current Sampler's SamplerType

getDescription

public java.lang.String getDescription()

Description copied from interface: Sampler

Human-readable description of this sampler's name and important qualities.

Specified by:

getDescription in interface Sampler

getThreshold

public long getThreshold()

Retrieve the current rejection threshold value

Returns:

the calculated rejection threshold