Axinom Mosaic Libraries
    Preparing search index...

    Interface IMonitoringOptions

    Options used to set up monitoring middleware.

    interface IMonitoringOptions {
        collectDefaultMetrics?: boolean;
        expressApp?: Application;
        metricRegistry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
        metrics?: Metric<string>[];
        metricsPath?: string;
    }
    Index

    Properties

    collectDefaultMetrics? expressApp? metricRegistry? metrics? metricsPath?

    Properties

    collectDefaultMetrics?: boolean

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

    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.

    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.

    metrics?: Metric<string>[]

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

    metricsPath?: string

    metricsPath: the path to mount the monitoring metric endpoint

    Settings

    Member Visibility

    On This Page

    Properties