Interface LogSink

A sink that receives batches of log events for output.

Sinks must implement AsyncDisposable for graceful shutdown. The flush() method is optional and forces immediate delivery of any buffered events.

interface LogSink {
    "[asyncDispose]"(): PromiseLike<void>;
    emit(events: LogEvent[]): Promise<void>;
    flush?(): Promise<void>;
}

Hierarchy

AsyncDisposable
- LogSink

Implemented by

BatchingSink

Index

Methods

[asyncDispose] emit flush?

Methods

[asyncDispose]

"[asyncDispose]"(): PromiseLike<void>
Returns PromiseLike<void>
Inherited from AsyncDisposable.[asyncDispose]
- Defined in node_modules/typescript/lib/lib.esnext.disposable.d.ts:38

emit

emit(events: LogEvent[]): Promise<void>
Write a batch of events to the output target.
Parameters
- events: LogEvent[]
Returns Promise<void>
- Defined in libs/log/src/Sink.ts:12

`Optional`flush

flush?(): Promise<void>
Force immediate delivery of buffered events.

Returns Promise<void>
- Defined in libs/log/src/Sink.ts:14