traceperf
    Preparing search index...

    Interface PrometheusExporter

    Extension point for exporters and custom sinks. Hooks run synchronously; errors thrown by a plugin are caught and reported once, never propagated into the tracked code.

    interface PrometheusExporter {
        name?: string;
        handler(
            req: unknown,
            res: {
                statusCode?: number;
                end(body: string): unknown;
                setHeader(name: string, value: string): unknown;
            },
        ): void;
        metrics(): string;
        onComplete?(root: ExecutionRecord): void;
        onStart?(execution: ExecutionStart): void;
        reset(): void;
        wrap?<R>(execution: ExecutionStart, run: () => R): R;
    }

    Hierarchy (View Summary)

    Index
    name?
    handler metrics onComplete? onStart? reset wrap?
    name?: string

    Optional name used in error messages

    • HTTP handler for Node http / Express / Koa-style (req, res) servers

      Parameters

      • req: unknown
      • res: {
            statusCode?: number;
            end(body: string): unknown;
            setHeader(name: string, value: string): unknown;
        }

      Returns void

    • Current metrics in Prometheus text format

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods