Class CustomSampler

Custom sampler that uses a sampling configuration to determine if a span should be sampled.

Implements

ExportSampler

Index

Constructors

Methods

isSamplingEnabled setConfig shouldSample

Constructors

constructor

new CustomSampler(sampler?: (ratio: number) => boolean): CustomSampler
Parameters
- sampler: (ratio: number) => boolean = defaultSampler
  The sampler to use. This is intended to be used for testing purposes.
Returns CustomSampler
- Defined in sdk/highlight-run/src/client/otel/sampling/CustomSampler.ts:67

Methods

isSamplingEnabled

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

Returns boolean
Implementation of ExportSampler.isSamplingEnabled
- Defined in sdk/highlight-run/src/client/otel/sampling/CustomSampler.ts:74

setConfig

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

shouldSample

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