Interface: AxiomSinkConfig

Defined in: observability/src/axiom.ts:9

Common batching / retry knobs for the three HTTP log sinks.

#Extends

• HttpBatchOptions

#Properties

#batchSize?

optional batchSize?: number

Defined in: observability/src/http-batch-sink.ts:13

Max events per POST. Default 25. Positive integer.

#Inherited from

HttpBatchOptions.batchSize

---

#dataset

dataset: string

Defined in: observability/src/axiom.ts:13

Dataset name to write into.

---

#endpoint?

optional endpoint?: string

Defined in: observability/src/axiom.ts:15

Override the ingest endpoint (e.g. EU region: https://api.eu.axiom.co).

---

#fetch?

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

Defined in: observability/src/http-batch-sink.ts:26

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

HttpBatchOptions.fetch

---

#flushIntervalMs?

optional flushIntervalMs?: number

Defined in: observability/src/http-batch-sink.ts:17

Periodic drain interval (ms). Default 2000. Finite > 0.

#Inherited from

HttpBatchOptions.flushIntervalMs

---

#maxQueueSize?

optional maxQueueSize?: number

Defined in: observability/src/http-batch-sink.ts:15

Hard queue cap; drop oldest when full. Default 1000. Positive integer.

#Inherited from

HttpBatchOptions.maxQueueSize

---

#maxRetries?

optional maxRetries?: number

Defined in: observability/src/http-batch-sink.ts:19

Retries after the initial attempt. Default 3. Integer ≥ 0.

#Inherited from

HttpBatchOptions.maxRetries

---

#onError?

optional onError?: (error) => void | Promise<void>

Defined in: observability/src/http-batch-sink.ts:25

Isolated error sink; throws/rejections never escape the observer.

#Parameters

error

unknown

#Returns

void | Promise<void>

#Inherited from

HttpBatchOptions.onError

---

#requestTimeoutMs?

optional requestTimeoutMs?: number

Defined in: observability/src/http-batch-sink.ts:23

Per-request timeout (ms). Default 10000. Positive integer.

#Inherited from

HttpBatchOptions.requestTimeoutMs

---

#retryBaseDelayMs?

optional retryBaseDelayMs?: number

Defined in: observability/src/http-batch-sink.ts:21

Base backoff delay (ms); doubled each attempt, capped at 30s, no jitter. Default 100.

#Inherited from

HttpBatchOptions.retryBaseDelayMs

---

#service?

optional service?: string

Defined in: observability/src/axiom.ts:17

Service name attached to every event.

---

#token

token: string

Defined in: observability/src/axiom.ts:11

Axiom API token.

Explore nearby

• Peer
  AdvancedCostGuard

  Auto-generated API reference for AdvancedCostGuard.

• Peer
  AdvancedCostGuardOptions

  Auto-generated API reference for AdvancedCostGuardOptions.

• Peer
  AppendAuditInput

  Auto-generated API reference for AppendAuditInput.