Install, update, or uninstall your Prometheus OpenMetrics integration

Before you install New Relic's Prometheus OpenMetrics integration, review the requirements.

Install in Kubernetes

We encourage you to use our automated installer for servers, VMs, and unprivileged environments which also covers the configuration of the monitorization of Kubernetes clusters.

You can find the documentation of how to install Kubernetes integration (which includes the feature flag for Prometheus OpenMetric's integration) here: Kubernetes integration: install and configure

Alternatively, we also offer fully manual instructions for deploying our integration using Helm.

By default, the New Relic Prometheus OpenMetrics integration uses the same labels as Prometheus to discover targets. For more information, see the metrics filtering documentation.

Confirm that the integration has been configured correctly: Wait a few minutes, then go to the New Relic UI, and run this NRQL query to see if data has been reported:

FROM Metric SELECT count(*) WHERE clusterName = 'YOUR_CLUSTER_NAME' since 1 hour ago

Docker

Install

To install the New Relic Prometheus OpenMetrics integration in a Docker environment:

Create a configuration file config.yaml. Use the example configuration file, or look at the nri-prometheus-latest.yaml manifest file, which includes the nri-prometheus-cfg config map and an example configuration.

Required: Add your New Relic license key and a cluster name to identify your Docker container.
Add the endpoints to scrape; for example, add the http://localhost:8080/metrics endpoint to collect metrics about the integration itself.
Specify which metrics you want to ignore or include according to the prefixes for the metrics and labels. For more information, see the metrics filtering documentation.

Start the integration in the background:

docker run -d --restart unless-stopped \
    --name nri-prometheus \
    -e LICENSE_KEY="YOUR_LICENSE_KEY" \
    -v "$(pwd)/config.yaml:/config.yaml" \
    newrelic/nri-prometheus:1.5

Confirm the container is running properly:
```
docker ps -f "name=nri-prometheus"
```
Confirm that the integration has been configured correctly: Wait a few minutes, then go to the New Relic UI, and run this NRQL query to see if data has been reported:
```
FROM Metric SELECT count(*) WHERE clusterName = 'YOUR_CLUSTER_NAME' since 1 hour ago
```

Update the integration

To update the Prometheus OpenMetrics integration, follow the procedures for Docker or Kubernetes as applicable:

Remove the Docker container.
Follow standard installation procedures to start a new Docker container.

The integration logs its current version when it starts up. To determine the running version:

docker logs nri-prometheus 2>&1 | grep "Integration version"

Example output:

time="2019-02-26T09:21:21Z" level=info msg="Starting New Relic's Prometheus OpenMetrics Integration version 1.0.0"

Uninstall

To uninstall the Prometheus OpenMetrics integration for Docker or Kubernetes, execute the following command:

docker rm -f nri-prometheus