Extract custom metrics from any Prometheus endpoints. Note: Datadog recommends using the OpenMetrics check since it is more efficient and fully supports Prometheus text format. Use the Prometheus check only when the metrics endpoint does not support a text format.
See the Prometheus metrics collection Getting Started to learn how to configure a Prometheus Check.
Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.
The Prometheus check is packaged with the Agent starting version 6.1.0.
prometheus.d/conf.yaml file to retrieve metrics from applications that expose OpenMetrics / Prometheus end points.
Each instance is at least composed of:
|A URL that points to the metric route (Note: must be unique)|
|This namespace is prepended to all metrics (to avoid metrics name collision)|
|A list of metrics to retrieve as custom metrics in the form |
When listing metrics, it’s possible to use the wildcard
* like this
- <METRIC_NAME>* to retrieve all matching metrics. Note: use wildcards with caution as it can potentially send a lot of custom metrics.
More advanced settings (ssl, labels joining, custom tags,…) are documented in the sample prometheus.d/conf.yaml
Due to the nature of this integration, it’s possible to submit a high number of custom metrics to Datadog. To provide users control over the maximum number of metrics sent in the case of configuration errors or input changes, the check has a default limit of 2000 metrics. If needed, this limit can be increased by setting the option
max_returned_metrics in the
send_monotonic_counter: True, the Agent sends the deltas of the values in question, and the in-app type is set to count (this is the default behaviour). If
send_monotonic_counter: False, the Agent sends the raw, monotonically increasing value, and the in-app type is set to gauge.
Run the Agent’s
status subcommand and look for
prometheus under the Checks section.
All metrics collected by the prometheus check are forwarded to Datadog as custom metrics.
Note: Bucket data for a given
<HISTOGRAM_METRIC_NAME> Prometheus histogram metric are stored in the
<HISTOGRAM_METRIC_NAME>.count metric within Datadog with the tags
upper_bound including the name of the buckets. To access the
+Inf bucket, use
The Prometheus check does not include any events.
The Prometheus check does not include any service checks.
Need help? Contact Datadog support.
Mistake in the docs? Feel free to contribute!