Class ParentBasedSampler

deprecated: Use the one defined in @opentelemetry/sdk-trace-base instead. A composite sampler that either respects the parent span's sampling decision or delegates to delegateSampler for root spans.

Hierarchy

ParentBasedSampler

Implements

Sampler

Index

Constructors

constructor

Methods

Constructors

constructor

new ParentBasedSampler(config: ParentBasedSamplerConfig): ParentBasedSampler

- Defined in packages/opentelemetry-core/src/trace/sampler/ParentBasedSampler.ts:44
Parameters
- config: ParentBasedSamplerConfig
Returns ParentBasedSampler

Methods

shouldSample

shouldSample(context: Context, traceId: string, spanName: string, spanKind: SpanKind, attributes: Attributes, links: Link[]): SamplingResult

Implementation of Sampler.shouldSample
- Defined in packages/opentelemetry-core/src/trace/sampler/ParentBasedSampler.ts:64
Checks whether span needs to be created and tracked.

Parameters
- context: Context
- traceId: string
- spanName: string
- spanKind: SpanKind
- attributes: Attributes
- links: Link[]
Returns SamplingResult
a SamplingResult.

toString

toString(): string

Implementation of Sampler.toString
- Defined in packages/opentelemetry-core/src/trace/sampler/ParentBasedSampler.ts:127
Returns the sampler name or short description with the configuration.

Returns string

Generated using TypeDoc