Class ParentBasedSampler

A composite sampler that either respects the parent span's sampling decision or delegates to delegateSampler for root spans.

Implements

node.Sampler

Index

Constructors

Methods

shouldSample toString

Constructors

constructor

new ParentBasedSampler(
config: ParentBasedSamplerConfig,
): node.ParentBasedSampler
Parameters
- config: ParentBasedSamplerConfig
Returns node.ParentBasedSampler
- Defined in packages/sdk-trace/build/src/sampler/ParentBasedSampler.d.ts:13

Methods

shouldSample

shouldSample(
    context: @opentelemetry/api.Context,
    traceId: string,
    spanName: string,
    spanKind: @opentelemetry/api.SpanKind,
    attributes: @opentelemetry/api.Attributes,
    links: @opentelemetry/api.Link[],
): node.SamplingResult
Checks whether span needs to be created and tracked.
Parameters
- context: @opentelemetry/api.Context
  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.
- spanName: string
  of the span to be created.
- spanKind: @opentelemetry/api.SpanKind
  of the span to be created.
- attributes: @opentelemetry/api.Attributes
  Initial set of Attributes for the Span being constructed.
- links: @opentelemetry/api.Link[]
  Collection of links that will be associated with the Span to be created. Typically useful for batch operations.
Returns node.SamplingResult
a SamplingResult.
Implementation of Sampler.shouldSample
- Defined in packages/sdk-trace/build/src/sampler/ParentBasedSampler.d.ts:14

toString

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

Returns string
Implementation of Sampler.toString
- Defined in packages/sdk-trace/build/src/sampler/ParentBasedSampler.d.ts:15