Setu-TS
    Preparing search index...

    Interface MetricsPluginOptions

    Plugin options for MetricsPlugin.

    interface MetricsPluginOptions {
        customMetrics?: readonly NamedMetricConfig[];
        defaultBuckets?: readonly number[];
        defaultMetrics?: boolean;
        defaultQuantiles?: readonly number[];
        endpoint?: string;
        excludePaths?: readonly PathPattern[];
        httpMetrics?: boolean;
    }
    Index
    customMetrics? defaultBuckets? defaultMetrics? defaultQuantiles? endpoint? excludePaths? httpMetrics?
    customMetrics?: readonly NamedMetricConfig[]

    Declarative metric definitions to pre-register.

    defaultBuckets?: readonly number[]

    Default histogram bucket boundaries.

    [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]
    defaultMetrics?: boolean

    Enable built-in HTTP metrics.

    true
    defaultQuantiles?: readonly number[]

    Default summary quantiles.

    [0.5, 0.9, 0.99]
    endpoint?: string

    The scrape endpoint path.

    '/metrics'
    excludePaths?: readonly PathPattern[]

    Request paths the HTTP metrics middleware skips entirely — no counter, histogram, or gauge is touched for them.

    When supplied this list REPLACES the default ['/health', '/live', '/ready'] set rather than extending it; the plugin's own endpoint is always excluded regardless, so /metrics can never count its own scrapes.

    ['/health', '/live', '/ready']
    httpMetrics?: boolean

    Enable the metrics middleware for HTTP request tracking.

    true

    Settings
    Member Visibility

    On This Page
    Properties