Class BatchingTransport

BatchingTransport buffers log entries and flushes them in batches.

Note: If flush() is called while a timer is pending, there is a potential race:

The timer callback could fire while flush() is executing
The timer is cleared at the start of flush() to mitigate this
However, if the timer fires simultaneously with flush(), entries may be written twice or the timer callback could operate on an empty buffer

Implements

LogTransport

Index

Constructors

Methods

Constructors

constructor

new BatchingTransport(
inner: LogTransport,
options?: { maxBatch?: number; flushMs?: number },
): BatchingTransport
Parameters
- inner: LogTransport
  The underlying transport to flush entries to
- options: { maxBatch?: number; flushMs?: number } = {}
  Batching configuration (maxBatch, flushMs)
  - OptionalmaxBatch?: number
    Maximum entries per batch. Default: 100
  - OptionalflushMs?: number
    Flush interval in ms. Default: 5000
Returns BatchingTransport
- Defined in src/logging.ts:415

Methods

write

write(entry: LogEntry): void
Buffer a single log entry. Triggers flush when maxBatch is reached.
Parameters
- entry: LogEntry
Returns void
Implementation of LogTransport.write
- Defined in src/logging.ts:426

flush

flush(): Promise<void>
Force-flush all buffered entries to the inner transport.

Returns Promise<void>
Implementation of LogTransport.flush
- Defined in src/logging.ts:438