Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • Sampler

Index

Methods

shouldSample

  • Checks whether span needs to be created and tracked.

    Parameters

    • parentContext: SpanContext | undefined

      Parent span context. Typically taken from the wire. Can be null.

    • 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: SpanKind

      of the span to be created.

    • attributes: Attributes

      Initial set of Attributes for the Span being constructed.

    • links: Link[]

      Collection of links that will be associated with the Span to be created. Typically useful for batch operations.

    Returns SamplingResult

    a SamplingResult.

toString

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

    Returns string