ClientOptions
Defined in: packages/core/src/client.ts:33
Properties
Section titled “Properties”apiKey?
Section titled “apiKey?”
optionalapiKey?:string
Defined in: packages/core/src/client.ts:40
Ingest-only key (slk_ingest_…).
dryRun?
Section titled “dryRun?”
optionaldryRun?:boolean
Defined in: packages/core/src/client.ts:61
Print events instead of sending them. Hashes use a throwaway local salt.
endpoint?
Section titled “endpoint?”
optionalendpoint?: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).
environment?
Section titled “environment?”
optionalenvironment?:string
Defined in: packages/core/src/client.ts:49
Separates staging from live. Default 'production'.
exporters?
Section titled “exporters?”
optionalexporters?: readonlyShardlensExporter[]
Defined in: packages/core/src/client.ts:42
In-process metrics exporters (Prometheus, OpenTelemetry). They receive every event, without users.
fetch?
Section titled “fetch?”
optionalfetch?: {(input,init?):Promise<Response>; (input,init?):Promise<Response>; }
Defined in: packages/core/src/client.ts:66
Override for tests and unusual runtimes.
Call Signature
Section titled “Call Signature”(
input,init?):Promise<Response>
Parameters
Section titled “Parameters”URL | RequestInfo
RequestInit
Returns
Section titled “Returns”Promise<Response>
Call Signature
Section titled “Call Signature”(
input,init?):Promise<Response>
Parameters
Section titled “Parameters”string | URL | Request
RequestInit
Returns
Section titled “Returns”Promise<Response>
flushIntervalMs?
Section titled “flushIntervalMs?”
optionalflushIntervalMs?:number
Defined in: packages/core/src/client.ts:53
Flush interval. Default 5,000 ms.
logger?
Section titled “logger?”
optionallogger?:Logger
Defined in: packages/core/src/client.ts:64
maxBatchSize?
Section titled “maxBatchSize?”
optionalmaxBatchSize?:number
Defined in: packages/core/src/client.ts:55
Events per batch (max 500). Default 500.
maxQueueSize?
Section titled “maxQueueSize?”
optionalmaxQueueSize?:number
Defined in: packages/core/src/client.ts:57
Memory ceiling, in events. Default 10,000.
optionalmode?:DataMode
Defined in: packages/core/src/client.ts:47
'audit' only takes effect when the collector is also in audit mode. Default 'privacy'.
random?
Section titled “random?”
optionalrandom?: () =>number
Defined in: packages/core/src/client.ts:68
Randomness in [0, 1), for jitter and sampling. Injectable for tests.
Returns
Section titled “Returns”number
release?
Section titled “release?”
optionalrelease?:string
Defined in: packages/core/src/client.ts:51
Your bot’s version, to compare releases.
sampleRate?
Section titled “sampleRate?”
optionalsampleRate?: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
Section titled “version”version:
string
source?
Section titled “source?”
optionalsource?: () =>SourceInfo
Defined in: packages/core/src/client.ts:63
Called for the current shard/cluster information each time a batch is built.
Returns
Section titled “Returns”spool?
Section titled “spool?”
optionalspool?:EventSpool
Defined in: packages/core/src/client.ts:44
Durable overflow for long collector outages (for example a disk spool). See EventSpool.