open-nomad/website/source/guides/nomad-metrics.html.md
2017-09-27 11:14:37 -07:00

2.8 KiB

layout page_title sidebar_current description
guides Setting up Nomad with Grafana and Prometheus Metrics guides-nomad-metrics It is possible to collect metrics on Nomad and create dashboards with Grafana and Prometheus. Nomad has default configurations for these, but it is possible to build and customize these.

Setting up Nomad with Grafana and Prometheus Metrics

Often aggregating and displaying metrics in dashboards can lead to more useful insights about a cluster. It is easy to get lost in a sea of logs!

This guide explains how to set up configuration for Prometheus and Grafana to integrate with a Nomad cluster. While this introduces the basics to get a dashboard up and running, Nomad exposes a wide variety of metrics, which can be explored via both Grafana and Prometheus.

What metrics tools can be integrated with Nomad?

Nomad provides the opportunity to integrate with metrics dashboard tools such as Prometheus, Grafana, Graphite, DataDog, and Circonus.

See Nomad's Metrics API for more information on how data can be exposed for other metrics tools as well.

Setting up metrics

Configurations for Grafana and Prometheus can be found in the integrations subfolder.

For Prometheus, first follow Prometheus's Getting Started Guide in order to set up a Prometheus server. Next, use the (Nomad Prometheus Configuration)[https://github.com/hashicorp/nomad/tree/master/integrations/prometheus/prometheus.yml] in order to configure Prometheus to talk to a Consul agent to fetch information about the Nomad cluster. See the README for more information.

For Grafana, follow Grafana's Getting Started guide to set up a running Grafana instance. Then, import the sample Nomad Dashboard for an example Grafana dashboard. This dashboard requires a Prometheus data source to be configured, see the README.md for more information.

Tagged Metrics

As of version 0.7, Nomad will start emitting metrics in a tagged format. Each metrics can support more than one tag, meaning that it is possible to do a match over metrics for datapoints such as a particular datacenter, and return all metrics with this tag.

See how Grafana enables tagged metrics easily.