OpenMetrics
Overview
Extract custom metrics from any OpenMetrics or Prometheus endpoints.
All the metrics retrieved by this integration are considered
custom metrics.
The integration is compatible with both the Prometheus exposition format as well as with the OpenMetrics specification.
Setup
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.
Installation
The OpenMetrics check is packaged with the Datadog Agent starting version 6.6.0.
Configuration
Edit the openmetrics.d/conf.yaml file at the root of your Agent’s configuration directory. See the sample openmetrics.d/conf.yaml for all available configuration options.
For each instance the following parameters are required:
| Parameter | Description |
|---|
openmetrics_endpoint | The URL where your application metrics are exposed in Prometheus or OpenMetrics format (must be unique). |
namespace | The namespace to prepend to all metrics. |
metrics | A list of metrics to retrieve as custom metrics. Add each metric to the list as metric_name or metric_name: renamed to rename it. The metrics are interpreted as regular expressions. Use ".*" as a wildcard (metric.*) to fetch all matching metrics. Note: Regular expressions can potentially send a lot of custom metrics. |
Note: This is a new default OpenMetrics check example as of Datadog Agent version 7.32.0. If you previously implemented this integration, see the legacy example.
Note: Starting in Datadog Agent v7.32.0, in adherence to the OpenMetrics specification standard, counter names ending in _total must be specified without the _total suffix. For example, to collect promhttp_metric_handler_requests_total, specify the metric name promhttp_metric_handler_requests. This submits to Datadog the metric name appended with .count, promhttp_metric_handler_requests.count.
Note: This check has a limit of 2000 metrics per instance. The number of returned metrics is indicated when running the Datadog Agent status command. You can specify the metrics you are interested in by editing the configuration. To learn how to customize the metrics to collect, see the Prometheus and OpenMetrics Metrics Collection for more detailed instructions. If you need to monitor more metrics, contact Datadog support.
For more configurations, see Prometheus and OpenMetrics Metrics Collection.
Validation
Run the Agent’s status subcommand and look for openmetrics under the Checks section.
Data Collected
Metrics
All metrics collected by the OpenMetrics check are forwarded to Datadog as custom metrics.
Events
The OpenMetrics check does not include any events.
Service Checks
The OpenMetrics check does not include any service checks.
Troubleshooting
High custom metrics billing
OpenMetrics configurations with generic wildcard values for the metrics option have significant impact on custom metrics billing.
Datadog recommends that you use specific metric names or partial metric name matches for more precise collection.
Need help? Contact Datadog support.
Further Reading
