Interface ExporterConfig

Configuration interface for prometheus exporter

interface ExporterConfig {
    appendTimestamp?: boolean;
    endpoint?: string;
    host?: string;
    metricProducers?: metrics.MetricProducer[];
    port?: number;
    prefix?: string;
    preventServerStart?: boolean;
    withResourceConstantLabels?: RegExp;
}

Properties

appendTimestamp? endpoint? host? metricProducers? port? prefix? preventServerStart? withResourceConstantLabels?

Properties

OptionalappendTimestamp

appendTimestamp?: boolean

Append timestamp to metrics

Default

true

Optionalendpoint

endpoint?: string

Endpoint the metrics should be exposed at with preceding slash

Default

'/metrics'

Optionalhost

host?: string

Default

undefined (all interfaces)

Optional ExperimentalmetricProducers

metricProducers?: metrics.MetricProducer[]

Note, this option is experimental. Additional MetricProducers to use as a source of aggregated metric data in addition to the SDK's metric data. The resource returned by these MetricProducers is ignored; the SDK's resource will be used instead.

Optionalport

port?: number

Port number for Prometheus exporter server

Default registered port is 9464: https://github.com/prometheus/prometheus/wiki/Default-port-allocations

Default

9464

Optionalprefix

prefix?: string

App prefix for metrics, if needed

Default

''

OptionalpreventServerStart

preventServerStart?: boolean

Prevent the Prometheus exporter server from starting

Default

false

OptionalwithResourceConstantLabels

withResourceConstantLabels?: RegExp

Regex pattern for defining which resource attributes will be applied as constant labels to the metrics. e.g. 'telemetry_.+' for all attributes starting with 'telemetry'.

Default

undefined (no resource attributes are applied)

Settings

Member Visibility

On This Page

Properties