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