Interface LogRecordProcessor

interface LogRecordProcessor {
    forceFlush(): Promise<void>;
    onEmit(logRecord: LogRecord, context?: Context): void;
    shutdown(): Promise<void>;
}

Implemented by

Methods

forceFlush onEmit shutdown

Methods

forceFlush

  • forceFlush(): Promise<void>

    Forces to export all finished log records

    Returns Promise<void>

onEmit

  • onEmit(logRecord: LogRecord, context?: Context): void

    Called when a LogRecord is emit

    Parameters

    • logRecord: LogRecord

      the ReadWriteLogRecord that just emitted.

    • Optionalcontext: Context

      the current Context, or an empty Context if the Logger was obtained with include_trace_context=false

    Returns void

shutdown

  • shutdown(): Promise<void>

    Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods