Nomad integration for Grafana Cloud

Nomad is a simple and flexible workload orchestrator to deploy and manage containers and non-containerized applications across on-prem and clouds at scale.

This integration includes 2 pre-built dashboards to help monitor and visualize Nomad metrics.

Before you begin

Add the telemetry stanza below in your Nomad client and server configuration files, by default it would be /etc/nomad.d/nomad.hcl:

telemetry {
  disable_hostname = true
  prometheus_metrics = true
  publish_allocation_metrics = true
  publish_node_metrics = true
}

Install Nomad integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find Nomad and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Nomad metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboards to your Grafana Cloud instance, and you can start monitoring your Nomad setup.

Post-install configuration for the Nomad integration

After enabling the metrics generation, you should instruct Grafana Agent to scrape each Nomad server and Nomad client that compose the Nomad cluster.

Each Nomad node exposes a /metrics endpoint. To scrape it, add the provided snippets to your agent configuration file.

Make sure to change the hostnames according to your environment.

Instead of using static discovery, consul service discovery can be used to discover all the nodes of the Nomad cluster.

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

    - job_name: integrations/nomad
      metrics_path: /v1/metrics
      params:
        format: ['prometheus']
      static_configs:
        - targets: ['nomad1:4646', 'nomad2:4646', 'nomad3:4646', 'nomad-client1:4646']

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Nomad integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

integrations:
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
    - job_name: integrations/nomad
      metrics_path: /v1/metrics
      params:
        format: ['prometheus']
      static_configs:
        - targets: ['nomad1:4646', 'nomad2:4646', 'nomad3:4646', 'nomad-client1:4646']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The Nomad integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

Nomad cluster
Nomad jobs

Nomad overview

Nomad jobs

Metrics

The most important metrics provided by the Nomad integration, which are used on the pre-built dashboards, are as follows:

nomad_client_allocs_cpu_total_percent
nomad_client_allocs_cpu_total_ticks
nomad_client_allocs_memory_cache
nomad_client_allocs_memory_rss
nomad_client_host_disk_available
nomad_client_host_disk_inodes_percent
nomad_client_host_disk_size
nomad_client_host_memory_available
nomad_client_host_memory_free
nomad_client_host_memory_total
nomad_client_host_memory_used
nomad_client_uptime

Changelog

# 0.0.3 - May 2022

* Update nomad-cluster dashboard:
  - Fix allocated gauges
* Update nomad-jobs dashboard:
  - Set decimal from fixed '3' to auto
  - Add tooltip sort: desc for tasks
  - Transform memory cache panel to timeseries graph
  - Fix units for CPU percentage

# 0.0.2 - April 2022

* Add Nomad setup prerequisites
* Add Nomad screenshot
* Add Nomad summary panels
* Fix panels repeat by $instance
* Fix queries: Remove not common service label from nomad selector
* Fix allocations and nomad clients gauge thresholds
* Flip CPU idle to CPU usage
* Fix instructions: Include format=prometheus in agent.jsonnet
* Update titles to Title case
* Rename $instance label from host to 'Nomad client'
* Remove vendor/ prefix from integration tag
* Transform nomad dashboards to jsonnet as is.

# 0.0.1 - July 2021

* Initial release

Cost

By connecting your Nomad instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.