@flarelog/sdk

---

@flarelog/sdk / FlareLogConfig

Interface: FlareLogConfig

Defined in: types.ts:61

Configuration options for the FlareLog client (v2 — OTel-native).

The biggest change from v1: apiKey is now OPTIONAL. With no API key and no OTLP endpoint configured, the SDK defaults to console output. This makes the SDK useful out-of-the-box with zero backend setup.

Properties

apiKey?

optional apiKey?: string

Defined in: types.ts:69

Flarelog API key (optional).

When provided, enables the Flarelog hosted backend transport. When omitted, the SDK still works — it just exports to console and/or any OTLP endpoint you configure via transports or env vars.

---

endpoint?

optional endpoint?: string

Defined in: types.ts:72

Flarelog endpoint. Defaults to https://flarelog.dev

---

allowInsecure?

optional allowInsecure?: boolean

Defined in: types.ts:75

Allow insecure HTTP endpoints (not recommended). Defaults to false

---

level?

optional level?: LogLevel

Defined in: types.ts:78

Minimum log level to send. Defaults to "DEBUG"

---

batchSize?

optional batchSize?: number

Defined in: types.ts:81

Number of logs to batch before sending. Defaults to 50 (Node), 1 (Worker)

---

flushIntervalMs?

optional flushIntervalMs?: number

Defined in: types.ts:84

Flush interval in milliseconds. Defaults to 5000 (Node), 0 (Worker)

---

debug?

optional debug?: boolean

Defined in: types.ts:87

Whether to enable debug logging (OTel diag logger + extra console output). Defaults to false

---

defaultSource?

optional defaultSource?: string

Defined in: types.ts:90

Default source tag for all logs

---

includeTimestamps?

optional includeTimestamps?: boolean

Defined in: types.ts:93

Whether to include timestamps automatically. Defaults to true

---

autoCapture?

optional autoCapture?: AutoCaptureConfig

Defined in: types.ts:96

Automatic error capture configuration

---

environment?

optional environment?: string

Defined in: types.ts:99

Environment name (e.g., "production", "staging", "development") — sets deployment.environment.name resource attr

---

release?

optional release?: string

Defined in: types.ts:102

Release version — sets service.version resource attr

---

serverName?

optional serverName?: string

Defined in: types.ts:105

Server hostname — sets host.name resource attr

---

serviceName?

optional serviceName?: string

Defined in: types.ts:108

Service name — sets service.name resource attr. Defaults to npm_package_name or "unknown_service"

---

serviceNamespace?

optional serviceNamespace?: string

Defined in: types.ts:111

Service namespace — sets service.namespace resource attr

---

resourceAttributes?

optional resourceAttributes?: Record<string, string>

Defined in: types.ts:114

Extra resource attributes (in addition to OTEL_RESOURCE_ATTRIBUTES env var)

---

beforeSend?

optional beforeSend?: (log) => false | LogEntry

Defined in: types.ts:117

Callback to modify or drop logs before sending. Return false to drop.

Parameters

log

LogEntry

Returns

false | LogEntry

---

scrubFields?

optional scrubFields?: string[]

Defined in: types.ts:120

Fields to scrub from metadata (PII redaction). Defaults to common sensitive fields.

---

sampleRate?

optional sampleRate?: number

Defined in: types.ts:123

Sample rate for logs (0.0 to 1.0). Defaults to 1.0 (100%)

---

maxBatchSize?

optional maxBatchSize?: number

Defined in: types.ts:126

Max in-flight buffer size. Defaults to 100

---

onDrop?

optional onDrop?: (droppedCount) => void

Defined in: types.ts:129

Callback invoked when logs are dropped due to buffer overflow.

Parameters

droppedCount

number

Returns

void

---

workerMode?

optional workerMode?: boolean

Defined in: types.ts:132

Worker mode: auto-detects if not set. When true, uses SimpleProcessor (flush on every event).

---

transports?

optional transports?: TransportConfig[]

Defined in: types.ts:138

Explicit list of transports. Overrides env-var-based auto-detection. Use this when you want full control (e.g. fan-out to console + OTLP + Flarelog).

---

otlpEndpoint?

optional otlpEndpoint?: string

Defined in: types.ts:145

OTLP/HTTP endpoint for any OTel backend (Grafana Cloud, Honeycomb, Tempo, etc.). Shorthand for transports: [{ type: "otlp", endpoint }]. Can also be set via OTEL_EXPORTER_OTLP_ENDPOINT env var.

---

otlpHeaders?

optional otlpHeaders?: Record<string, string>

Defined in: types.ts:148

Headers for the OTLP transport (e.g. Authorization). Shorthand for transports[0].headers.