Interface ExportSampler

A sampler that runs during the export phase of the trace pipeline.

interface ExportSampler {
    isSamplingEnabled(): boolean;
    setConfig(config?: Maybe<SamplingConfig>): void;
    shouldSample(span: ReadableSpan): SamplingResult;
}

Implemented by

CustomSampler

Index

Methods

isSamplingEnabled setConfig shouldSample

Methods

isSamplingEnabled

isSamplingEnabled(): boolean
Returns true if sampling is enabled. If there are no sampling configurations, then sampling can be skipped.

Returns boolean
- Defined in sdk/highlight-run/src/client/otel/sampling/ExportSampler.ts:31

setConfig

setConfig(config?: Maybe<SamplingConfig>): void
Parameters
- Optionalconfig: Maybe<SamplingConfig>
Returns void
- Defined in sdk/highlight-run/src/client/otel/sampling/ExportSampler.ts:33

shouldSample

shouldSample(span: ReadableSpan): SamplingResult
Returns a sampling result for a span.
Parameters
- span: ReadableSpan
  The span to sample.
Returns SamplingResult
- Defined in sdk/highlight-run/src/client/otel/sampling/ExportSampler.ts:26