Monitor infrastructure

Grafana integrations

Integrations reference

Nomad

Grafana Cloud

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.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single Nomad instance running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Metrics snippets

discovery.relabel "metrics_integrations_integrations_nomad" {
	targets = concat(
		[{
			__address__ = "nomad1:4646",
		}],
		[{
			__address__ = "nomad2:4646",
		}],
		[{
			__address__ = "nomad3:4646",
		}],
		[{
			__address__ = "nomad-client1:4646",
		}],
	)

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_nomad" {
	targets    = discovery.relabel.metrics_integrations_integrations_nomad.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/nomad"
	params     = {
		format = ["prometheus"],
	}
	metrics_path = "/v1/metrics"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Nomad instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

discovery.relabel "metrics_integrations_integrations_nomad" {
	targets = concat(
		[{
			__address__ = "nomad1:4646",
		}],
		[{
			__address__ = "nomad2:4646",
		}],
		[{
			__address__ = "nomad3:4646",
		}],
		[{
			__address__ = "nomad-client1:4646",
		}],
	)

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_nomad" {
	targets    = discovery.relabel.metrics_integrations_integrations_nomad.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/nomad"
	params     = {
		format = ["prometheus"],
	}
	metrics_path = "/v1/metrics"
}

To monitor your Nomad instance, you must use a discovery.relabel component to discover your Nomad Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

__address__: The address to your Nomad Prometheus metrics endpoint.
instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Nomad instance.

If you have multiple Nomad servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

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']
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      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:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  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_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
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:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/nomad
      metrics_path: /v1/metrics
      params:
        format: ['prometheus']
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      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_allocated_cpu
nomad_client_allocated_disk
nomad_client_allocated_memory
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_cpu_idle
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_unallocated_cpu
nomad_client_unallocated_disk
nomad_client_unallocated_memory
nomad_client_uptime
up

Changelog

# 0.0.6 - November 2023

* Replaced Angular dashboard panels with React panels

# 0.0.5 - September 2023

* Update Grafana Agent configuration snippets to include filtered metrics used in gauge panels

# 0.0.4 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 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.