Interface Opts

Options for configuring metrics middleware.

interface Opts {
    collectNodeMetrics: boolean;
    collectServiceVersion: boolean;
    customLabels: { [key: string]: any };
    includeOperationId: boolean;
    labels: Record<string, string>;
    prefix: string;
    registry: Registry;
    transformLabels?: TransformLabelsFn;
}

Properties

collectNodeMetrics collectServiceVersion customLabels includeOperationId labels prefix registry transformLabels?

Properties

collectNodeMetrics

collectNodeMetrics: boolean

Whether to collect node metrics.

collectServiceVersion

collectServiceVersion: boolean

Whether to collect service version metrics.

customLabels

customLabels: { [key: string]: any }

Object containing extra labels, useful together with transformLabels.

includeOperationId

includeOperationId: boolean

Add operation id based on the Openapi operationId to the metrics. Requires the express-openapi-validator package to function.

Default

true

labels

labels: Record<string, string>

The labels to attach to all the metrics.

prefix

prefix: string

The prefix for the metrics. e.g. 'my_prefix_my_metric'

registry

registry: Registry

The Prometheus registry to use for the metrics.

OptionaltransformLabels

transformLabels?: TransformLabelsFn

Function to transform labels with request and response objects.

Settings

Member Visibility

On This Page

Properties