Class TraceIdRatioBasedSampler

Sampler that samples a given fraction of traces based of trace id deterministically.

Implements

Sampler

Index

Constructors

Methods

shouldSample toString

Constructors

constructor

new TraceIdRatioBasedSampler(ratio?: number): TraceIdRatioBasedSampler
Parameters
- ratio: number = 0
Returns TraceIdRatioBasedSampler
- Defined in sampler/TraceIdRatioBasedSampler.ts:15

Methods

shouldSample

shouldSample(context: unknown, traceId: string): SamplingResult
Checks whether span needs to be created and tracked.
Parameters
- context: unknown
  Parent Context which may contain a span.
- traceId: string
  of the span to be created. It can be different from the traceId in the SpanContext. Typically in situations when the span to be created starts a new trace.
Returns SamplingResult
a SamplingResult.
Implementation of Sampler.shouldSample
- Defined in sampler/TraceIdRatioBasedSampler.ts:21

toString

toString(): string
Returns the sampler name or short description with the configuration.

Returns string
Implementation of Sampler.toString
- Defined in sampler/TraceIdRatioBasedSampler.ts:30