Interface Sampler

deprecated: use the one declared in @opentelemetry/sdk-trace-base instead. 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.
since: 1.0.0

Hierarchy

Sampler

Index

Methods

Methods

shouldSample

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

- Defined in api/src/trace/Sampler.ts:46
Checks whether span needs to be created and tracked.

Parameters
- context: 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: SpanKind
  
  of the span to be created.
- attributes: Attributes
  
  Initial set of SpanAttributes 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

- Defined in api/src/trace/Sampler.ts:56
Returns the sampler name or short description with the configuration.

Returns string

Generated using TypeDoc