Skip to content

ClientOptions

Defined in: packages/core/src/client.ts:33

optional apiKey?: string

Defined in: packages/core/src/client.ts:40

Ingest-only key (slk_ingest_…).


optional dryRun?: boolean

Defined in: packages/core/src/client.ts:61

Print events instead of sending them. Hashes use a throwaway local salt.


optional endpoint?: string

Defined in: packages/core/src/client.ts:38

Collector base URL. HTTPS, or HTTP to localhost only. Leave out together with apiKey to run without a collector (exporters only).


optional environment?: string

Defined in: packages/core/src/client.ts:49

Separates staging from live. Default 'production'.


optional exporters?: readonly ShardlensExporter[]

Defined in: packages/core/src/client.ts:42

In-process metrics exporters (Prometheus, OpenTelemetry). They receive every event, without users.


optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/core/src/client.ts:66

Override for tests and unusual runtimes.

(input, init?): Promise<Response>

MDN Reference

URL | RequestInfo

RequestInit

Promise<Response>

(input, init?): Promise<Response>

MDN Reference

string | URL | Request

RequestInit

Promise<Response>


optional flushIntervalMs?: number

Defined in: packages/core/src/client.ts:53

Flush interval. Default 5,000 ms.


optional logger?: Logger

Defined in: packages/core/src/client.ts:64


optional maxBatchSize?: number

Defined in: packages/core/src/client.ts:55

Events per batch (max 500). Default 500.


optional maxQueueSize?: number

Defined in: packages/core/src/client.ts:57

Memory ceiling, in events. Default 10,000.


optional mode?: DataMode

Defined in: packages/core/src/client.ts:47

'audit' only takes effect when the collector is also in audit mode. Default 'privacy'.


optional random?: () => number

Defined in: packages/core/src/client.ts:68

Randomness in [0, 1), for jitter and sampling. Injectable for tests.

number


optional release?: string

Defined in: packages/core/src/client.ts:51

Your bot’s version, to compare releases.


optional sampleRate?: Readonly<Record<string, number>>

Defined in: packages/core/src/client.ts:59

Sample rate per event type, in (0, 1]. Kept events carry weight = 1 / rate. The collector’s settings win.


sdk: object

Defined in: packages/core/src/client.ts:45

name: string

version: string


optional source?: () => SourceInfo

Defined in: packages/core/src/client.ts:63

Called for the current shard/cluster information each time a batch is built.

SourceInfo


optional spool?: EventSpool

Defined in: packages/core/src/client.ts:44

Durable overflow for long collector outages (for example a disk spool). See EventSpool.