Interface IMonitoringOptions

Options used to set up monitoring middleware.

Hierarchy

  • IMonitoringOptions

Properties

collectDefaultMetrics? expressApp? metricRegistry? metrics? metricsPath?

Properties

Optional collectDefaultMetrics

collectDefaultMetrics?: boolean

collectDefaultMetrics: a flag indicating if default metrics for nodejs should be included into the registry.

Optional expressApp

expressApp?: Application

expressApp: an express application where the monitoring middleware will be mounted on. if not specified, a new express app will be created listening on the METRICS_ENDPOINT_PORT port.

Optional metricRegistry

metricRegistry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

metricRegistry: a custom prom-client registry to be used to attach custom metrics to.

Optional metrics

metrics?: Metric<string>[]

metrics: an array of Metrics to be added to the Registry for metric collection.

Optional metricsPath

metricsPath?: string

metricsPath: the path to mount the monitoring metric endpoint

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc