Interface Sampler

This interface represent a sampler. Sampling is a mechanism to control the noise and overhead introduced by OpenTelemetry by reducing the number of samples of traces collected and sent to the backend.

interface Sampler {
    shouldSample(
        context: @opentelemetry/api.Context,
        traceId: string,
        spanName: string,
        spanKind: @opentelemetry/api.SpanKind,
        attributes: @opentelemetry/api.Attributes,
        links: @opentelemetry/api.Link[],
    ): node.SamplingResult;
    toString(): string;
}

Implemented by

Index

Methods

shouldSample toString

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.
- Defined in packages/sdk-trace/build/src/Sampler.d.ts:66

toString

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

Returns string
- Defined in packages/sdk-trace/build/src/Sampler.d.ts:68

Interface Sampler

Implemented by

Index

Methods

Methods

shouldSample

Parameters

Returns node.SamplingResult

toString

Returns string

Settings

On This Page