Documentation - v7.13.0
    Preparing search index...

    Interface OnInitOptionsExperimental

    onInit plugin API options.

    interface OnInitOptions {
        initConfiguration: LogsInitConfiguration;
        publicApi: DatadogLogs;
        registerAssembleEventHook: (
            this: void,
            callback: (
                params: AssembleHookParams,
            ) => "DISCARDED" | "SKIPPED" | RecursivePartial<LogsEvent>,
        ) => { unregister: () => void };
    }
    Index
    initConfiguration publicApi registerAssembleEventHook
    initConfiguration: LogsInitConfiguration
    publicApi: DatadogLogs
    registerAssembleEventHook: (
        this: void,
        callback: (
            params: AssembleHookParams,
        ) => "DISCARDED" | "SKIPPED" | RecursivePartial<LogsEvent>,
    ) => { unregister: () => void }

    Register a callback invoked when a log event is assembled, so plugins can enrich or override log fields before they are sent. Callbacks registered in onInit run before any log is assembled, including logs buffered during the pre-start phase.

    Type Declaration

      • (
            this: void,
            callback: (
                params: AssembleHookParams,
            ) => "DISCARDED" | "SKIPPED" | RecursivePartial<LogsEvent>,
        ): { unregister: () => void }

      • Registers a callback and returns a handle to unregister it.

        Parameters

        Returns { unregister: () => void }

    Settings

    On This Page
    Properties