Extract custom metrics from any OpenMetrics endpoints.
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 OpenMetrics check is packaged with the Datadog Agent starting version 6.6.0.
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 by Prometheus (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. Use * as a wildcard (metric*) to fetch all matching metrics. Note: Wildcards can potentially send a lot of custom metrics. |
Note: This is a new default OpenMetrics check example. If you previously implemented this integration, see the legacy example.
For more configurations, see Prometheus and OpenMetrics Metrics Collection.
Run the Agent’s status subcommand and look for openmetrics under the Checks section.
All metrics collected by the OpenMetrics check are forwarded to Datadog as custom metrics.
The OpenMetrics check does not include any events.
The OpenMetrics check does not include any service checks.
Need help? Contact Datadog support.
