@flowscripter/pluggable-io-framework-api
    Preparing search index...

    Interface TelemetryHooks

    Global telemetry hooks supplied once at framework initialisation. Every operation is given a correlation ID and reports through the same hooks, tagged with that ID/operation-type. Callers don't need to thread a callback through every call, but can still track individual operations via the ID in emitted events.

    interface TelemetryHooks {
        onMetric?(
            event: { name: string; tags?: Record<string, string>; value: number },
        ): void;
        onProgress?(
            event: {
                bytesProcessed: number;
                operationId: string;
                totalBytes?: number;
                type: string;
            },
        ): void;
    }
    Index
    onMetric? onProgress?

    • Parameters

      • event: { name: string; tags?: Record<string, string>; value: number }

      Returns void

    • Parameters

      • event: {
            bytesProcessed: number;
            operationId: string;
            totalBytes?: number;
            type: string;
        }

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods