Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/observability / / SamplingOptions
Interface: SamplingOptions
Defined in: packages/observability/src/tracer/sampling.ts:38
Configuration shape consumed by createSampler.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
decisionMaker? | readonly | SamplingDecisionMaker | Decision maker. Defaults to 'parent-based'. | packages/observability/src/tracer/sampling.ts:44 |
maxPerSecond? | readonly | number | Cap for the 'rate-limit' decision maker: at most this many root spans are sampled per rolling 1-second window (RP-19). undefined ⇒ no cap (samples everything); 0 ⇒ sample nothing. Ignored by the other decision makers. | packages/observability/src/tracer/sampling.ts:51 |
now? | readonly | () => number | Internal Clock for the 'rate-limit' window. Defaults to Date.now. | packages/observability/src/tracer/sampling.ts:57 |
random? | readonly | () => number | Internal Override for the random source. Useful for deterministic tests. | packages/observability/src/tracer/sampling.ts:71 |
rate? | readonly | number | Default head-sampling rate. Must be in [0, 1]. Defaults to 1.0. | packages/observability/src/tracer/sampling.ts:40 |
rules? | readonly | readonly SamplingRule[] | Per-type overrides. Last write wins on duplicate type. | packages/observability/src/tracer/sampling.ts:42 |
streaming? | readonly | { eventSamplingRate?: number; includeChunkContent?: "none" | "text-only" | "all"; } | Optional override for streaming-event sampling. See RB-52 - streaming event family tool.execute.{progress,partial}. | packages/observability/src/tracer/sampling.ts:62 |
streaming.eventSamplingRate? | readonly | number | - | packages/observability/src/tracer/sampling.ts:63 |
streaming.includeChunkContent? | readonly | "none" | "text-only" | "all" | - | packages/observability/src/tracer/sampling.ts:64 |