fastify-metrics.imetricspluginoptions.md

Home > fastify-metrics > IMetricsPluginOptions

IMetricsPluginOptions interface

Metrics plugin config

Signature:

export interface IMetricsPluginOptions 

Properties

Property	Modifiers	Type	Description
clearRegisterOnInit		boolean	Clears the prom-client global registry before adding metrics. Default to false
defaultMetrics		IDefaultMetricsConfig	Default prom-client metrics config. Collect prometheus recommended and node.js specific metrics like event loop lag.
endpoint		string | null | RouteOptions	Endpoint to expose metrics in prometheus format. null - disables metrics exposure
name		string	Plugin name that will be registered in fastify instance.
promClient		typeof client | null	PromClient instance to override default internal promClient
routeMetrics		IRouteMetricsConfig	Per route metrics config. Collect response time metric on requests