Package io.opencensus.trace.samplers
Class Samplers
- java.lang.Object
-
- io.opencensus.trace.samplers.Samplers
-
public final class Samplers extends java.lang.Object
Static class to access a set of pre-definedSamplers
.- Since:
- 0.5
-
-
Field Summary
Fields Modifier and Type Field Description private static Sampler
ALWAYS_SAMPLE
private static Sampler
NEVER_SAMPLE
-
Constructor Summary
Constructors Modifier Constructor Description private
Samplers()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Sampler
alwaysSample()
static Sampler
neverSample()
static Sampler
probabilitySampler(double probability)
Returns aSampler
that makes a "yes" decision with a given probability.
-
-
-
Method Detail
-
alwaysSample
public static Sampler alwaysSample()
- Returns:
- a
Sampler
that always makes a "yes" decision onSpan
sampling. - Since:
- 0.5
-
neverSample
public static Sampler neverSample()
- Returns:
- a
Sampler
that always makes a "no" decision onSpan
sampling. - Since:
- 0.5
-
probabilitySampler
public static Sampler probabilitySampler(double probability)
Returns aSampler
that makes a "yes" decision with a given probability.- Parameters:
probability
- The desired probability of sampling. Must be within [0.0, 1.0].- Returns:
- a
Sampler
that makes a "yes" decision with a given probability. - Throws:
java.lang.IllegalArgumentException
- ifprobability
is out of range- Since:
- 0.5
-
-