Monitor infrastructure

Grafana integrations

Integrations reference

dnsmasq

Grafana Cloud

dnsmasq integration for Grafana Cloud

dnsmasq is a network infrastructure provider for small networks. It provides DNS, DHCP, router advertisement, and more. This integration enables the agent to send metrics to Grafana Cloud along with a useful default dashboard for visualization.

This integration includes 1 pre-built dashboard to help monitor and visualize dnsmasq metrics.

Before you begin

This integration relies on a dnsmasq service running alongside Grafana Alloy. See the following sections for details.

Install dnsmasq integration for Grafana Cloud

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

Configuration snippets for Grafana Alloy

Simple mode

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

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

Integrations snippets

prometheus.exporter.dnsmasq "integrations_dnsmasq_exporter" { }

discovery.relabel "integrations_dnsmasq_exporter" {
	targets = prometheus.exporter.dnsmasq.integrations_dnsmasq_exporter.targets

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

	rule {
		target_label = "job"
		replacement  = "integrations/dnsmasq_exporter"
	}
}

prometheus.scrape "integrations_dnsmasq_exporter" {
	targets    = discovery.relabel.integrations_dnsmasq_exporter.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/dnsmasq_exporter"
}

Advanced mode

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

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

Advanced integrations snippets

prometheus.exporter.dnsmasq "integrations_dnsmasq_exporter" { }

discovery.relabel "integrations_dnsmasq_exporter" {
	targets = prometheus.exporter.dnsmasq.integrations_dnsmasq_exporter.targets

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

	rule {
		target_label = "job"
		replacement  = "integrations/dnsmasq_exporter"
	}
}

prometheus.scrape "integrations_dnsmasq_exporter" {
	targets    = discovery.relabel.integrations_dnsmasq_exporter.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/dnsmasq_exporter"
}

This integrations uses the prometheus.exporter.dnsmasq component to generate metrics from a dnsmasq instance.

Set the address argument to the address of your dnsmasq instance.

For the full array of configuration options, refer to the prometheus.exporter.dnsmasq component reference documentation.

This exporter must be linked with a discovery.relabel component to apply the necessary relabelings.

For each dnsmasq instance to be monitored you must create a pair of these components.

Configure the following properties within each discovery.relabel component:

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 dnsmasq instance.

You can then scrape them by including each discovery.relabel 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

This integration relies on a dnsmasq service running alongside Grafana Agent. See the following sections for details.

Install dnsmasq integration for Grafana Cloud

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

Post-install configuration for the dnsmasq integration

This integration is configured to work with the dnsmasq_exporter, which is embedded in Grafana Agent.

Enable the integration by adding the provided snippet to your agent configuration file.

Make sure to change the value of dnsmasq_address to the address of the server you want to monitor in the agent config.

For a full description of configuration options see how to configure the dnsmasq_exporter_config block in the agent documentation.

Configuration snippets for Grafana Agent

Below integrations, insert the following lines and change the URLs according to your environment:

  dnsmasq_exporter:
    enabled: true
    dnsmasq_address: localhost:53
    instance: '<your-instance-name>'

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 dnsmasq 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.
  dnsmasq_exporter:
    enabled: true
    dnsmasq_address: localhost:53
    instance: '<your-instance-name>'
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.
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

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

dnsmasq

Metrics

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

dnsmasq_cachesize
dnsmasq_exporter_build_info
dnsmasq_hits
dnsmasq_insertions
dnsmasq_leases
dnsmasq_servers_queries
dnsmasq_servers_queries_failed
up

Changelog

# 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 - January 2023

* Update mixin to the latest version:
  - Mixin now uses latest Grafana schema
  - Template variables have correct labels and allow multi-select

# 0.0.2 - September 2022

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'

# 0.0.1 - November 2020

* Initial release

Cost

By connecting your dnsmasq 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.