Skip to main content

Interface: PrometheusMetricsExporter

Prometheus metrics exporter options

Properties​

prometheus​

prometheus: object

bindAddress​

bindAddress: string

Address to bind the Prometheus HTTP metrics exporter server (for example, 0.0.0.0:1234).

Metrics will be available for scraping under the standard /metrics route.

countersTotalSuffix?​

optional countersTotalSuffix?: boolean

If set to true, all counter names will include a "_total" suffix.

Default​
false

histogramBucketOverrides?​

optional histogramBucketOverrides?: Record<string, number[]>

Overrides boundary values for histogram metrics.

The key is the metric name and the value is the list of bucket boundaries.

For example:

{
"request_latency": [1, 5, 10, 25, 50, 100, 250, 500, 1000],
}

The metric name will apply regardless of name prefixing.

See this doc for the exact meaning of boundaries.

unitSuffix?​

optional unitSuffix?: boolean

If set to true, all histograms will include the unit in their name as a suffix. EX: "_milliseconds"

Default​
false

useSecondsForDurations?​

optional useSecondsForDurations?: boolean

If set to true, the exporter will use seconds for durations instead of milliseconds.

Default​
false