Interface ProviderInstrumentation

Convenience wrapper used by providers to emit safe, watcher-aware events.

interface ProviderInstrumentation {
    port:
        | ProviderInstrumentationPort<
            ProviderInstrumentationEvent,
            string,
            unknown,
        >
        | undefined;
    custom(event: ProviderCustomInstrumentationEventInput): unknown;
    isEnabled(watcher?: string): boolean;
    record(event: ProviderInstrumentationEvent): unknown;
}

Index

Properties

Methods

custom isEnabled record

Properties

port

port:
    | ProviderInstrumentationPort<
        ProviderInstrumentationEvent,
        string,
        unknown,
    >
    | undefined

Resolved instrumentation port, when one is available.

Methods

custom

custom(event: ProviderCustomInstrumentationEventInput): unknown
Record a provider-owned custom event.
Parameters
- event: ProviderCustomInstrumentationEventInput
Returns unknown
- Defined in packages/core/src/providers/instrumentation.ts:308

isEnabled

isEnabled(watcher?: string): boolean
Return whether the given watcher is enabled.
Parameters
- Optionalwatcher: string
Returns boolean
- Defined in packages/core/src/providers/instrumentation.ts:300

record

record(event: ProviderInstrumentationEvent): unknown
Record a fully formed provider instrumentation event.
Parameters
- event: ProviderInstrumentationEvent
Returns unknown
- Defined in packages/core/src/providers/instrumentation.ts:304