Interface LogRecordProcessor

interface LogRecordProcessor {
    enabled(
        options: {
            context: @opentelemetry/api.Context;
            eventName?: string;
            instrumentationScope: core.InstrumentationScope;
            severityNumber?: SeverityNumber;
        },
    ): boolean;
    forceFlush(): Promise<void>;
    onEmit(
        logRecord: logs.SdkLogRecord,
        context?: @opentelemetry/api.Context,
    ): void;
    shutdown(): Promise<void>;
}

Implemented by

Methods

enabled? forceFlush onEmit shutdown

Methods

Optionalenabled

forceFlush

  • forceFlush(): Promise<void>

    Forces to export all finished log records

    Returns Promise<void>

onEmit

  • onEmit(logRecord: logs.SdkLogRecord, context?: @opentelemetry/api.Context): void

    Called when a LogRecord is emit

    Parameters

    • logRecord: logs.SdkLogRecord

      the ReadWriteLogRecord that just emitted.

    • Optionalcontext: @opentelemetry/api.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