Interface RumPlugin`Experimental`

Plugin interface of the RUM browser SDK.

The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.

interface RumPlugin {
    name: string;
    getConfigurationTelemetry(): Record<string, unknown>;
    onInit(
        options: {
            initConfiguration: RumInitConfiguration;
            publicApi: RumGlobal;
        },
    ): void;
    onRumStart(options: OnRumStartOptions): void;
}

Index

Properties

Methods

getConfigurationTelemetry? onInit? onRumStart?

Properties

`Experimental`name

name: string

Methods

`Optional`getConfigurationTelemetry

getConfigurationTelemetry(): Record<string, unknown>
Experimental
Returns Record<string, unknown>
- Defined in packages/rum-core/src/domain/plugins.ts:32

`Optional`onInit

onInit(
    options: {
        initConfiguration: RumInitConfiguration;
        publicApi: RumGlobal;
    },
): void
Experimental
Parameters
- options: { initConfiguration: RumInitConfiguration; publicApi: RumGlobal }
Returns void
- Defined in packages/rum-core/src/domain/plugins.ts:33

`Optional`onRumStart

onRumStart(options: OnRumStartOptions): void
Experimental
Parameters
- options: OnRumStartOptions
Returns void
- Defined in packages/rum-core/src/domain/plugins.ts:34