com.newrelic.agent.tracing.samplers

Interface Sampler

All Known Implementing Classes:

AdaptiveSampler, AlwaysOffSampler, AlwaysOnSampler, ProbabilityBasedSampler, TraceRatioBasedSampler

public interface Sampler

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.
SamplerType	getType() Get the type of this Sampler
static boolean	isValidSamplingTarget(int target) Determine if the supplied int value is a valid value for the adaptive sampling target
static boolean	isValidTraceRatio(float ratio) Determine if the supplied float value is a valid value for the ratio value
static java.lang.String	traceIdFromTransaction(Transaction tx) Extract the trace id from the supplied Transaction instance

Method Detail

traceIdFromTransaction

static java.lang.String traceIdFromTransaction(Transaction tx)

Extract the trace id from the supplied Transaction instance

Parameters:

tx - The target Transaction

Returns:

the extracted trace id or null if the Transaction instance is null

isValidTraceRatio

static boolean isValidTraceRatio(float ratio)

Determine if the supplied float value is a valid value for the ratio value

Parameters:

ratio - the ratio value to check

Returns:

true if the ratio is valid; false otherwise

isValidSamplingTarget

static boolean isValidSamplingTarget(int target)

Determine if the supplied int value is a valid value for the adaptive sampling target

Parameters:

target - the target value to check

Returns:

true if the target is valid; false otherwise

calculatePriority

float calculatePriority(Transaction tx,
                        Granularity granularity)

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

Parameters:

tx - the transaction to calculate the priority for

Returns:

a priority value between 0.0f - 2.0f, inclusive

getType

SamplerType getType()

Get the type of this Sampler

Returns:

the current Sampler's SamplerType

getDescription

java.lang.String getDescription()

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