Status | |
---|---|
Stability | beta: metrics |
Distributions | core, contrib, aws, observiq, sumo |
Exports data in the Prometheus format, which allows it to be scraped by a Prometheus server.
The following settings are required:
endpoint
(no default): the address on which metrics will be exposed, using path/metrics
. For full list ofHTTPServerSettings
refer here.
The following settings can be optionally configured:
const_labels
(no default): key/values that are applied for every exported metric.namespace
(no default): if set, exports metrics under the provided value.send_timestamps
(default =false
): if true, sends the timestamp of the underlying metric sample in the response.metric_expiration
(default =5m
): defines how long metrics are exposed without updatesresource_to_telemetry_conversion
enabled
(default = false): Ifenabled
istrue
, all the resource attributes will be converted to metric labels by default.
enable_open_metrics
: (default =false
): If true, metrics will be exported using the OpenMetrics format. Exemplars are only exported in the OpenMetrics format, and only for histogram and monotonic sum (i.e. counter) metrics.
Example:
exporters:
prometheus:
endpoint: "1.2.3.4:1234"
tls:
ca_file: "/path/to/ca.pem"
cert_file: "/path/to/cert.pem"
key_file: "/path/to/key.pem"
namespace: test-space
const_labels:
label1: value1
"another label": spaced value
send_timestamps: true
metric_expiration: 180m
enable_open_metrics: true
resource_to_telemetry_conversion:
enabled: true
Given the example, metrics will be available at https://1.2.3.4:1234/metrics
.
OpenTelemetry metric names and attributes are normalized to be compliant with Prometheus naming rules. Details on this normalization process are described in the Prometheus translator module.