Class TraceIdRatioBasedSampler

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

Hierarchy

TraceIdRatioBasedSampler

Implements

Sampler

Index

Constructors

constructor

Methods

Constructors

constructor

new TraceIdRatioBasedSampler(_ratio?: number): TraceIdRatioBasedSampler

- Defined in packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts:24
Parameters
- _ratio: number = 0
Returns TraceIdRatioBasedSampler

Methods

shouldSample

shouldSample(context: unknown, traceId: string): SamplingResult

Implementation of Sampler.shouldSample
- Defined in packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts:29
Checks whether span needs to be created and tracked.

Parameters
- context: unknown
- traceId: string
Returns SamplingResult

toString

toString(): string

Implementation of Sampler.toString
- Defined in packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts:38
Returns the sampler name or short description with the configuration.

Returns string

Generated using TypeDoc