interface MetricsPluginOptions

Plugin options for MetricsPlugin.

Properties

readonly
optional
endpoint: string

The scrape endpoint path.

readonly
optional
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.

readonly
optional
defaultMetrics: boolean

Enable built-in HTTP metrics.

readonly
optional
httpMetrics: boolean

Enable the metrics middleware for HTTP request tracking.

readonly
optional
customMetrics: readonly NamedMetricConfig[]

Declarative metric definitions to pre-register.

readonly
optional
defaultBuckets: readonly number[]

Default histogram bucket boundaries.

readonly
optional
defaultQuantiles: readonly number[]

Default summary quantiles.

Usage

import { type MetricsPluginOptions } from "metrics-plugin/src/index.ts";