Dnsmasq

Plugin: go.d.plugin Module: dnsmasq

Overview

This collector monitors Dnsmasq servers.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the dnsmasq collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for dnsmasq, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit `go.d/dnsmasq.conf` and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

No action required.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

<details open><summary>Config options</summary>

Group	Option	Description	Default	Required
Collection	update_every	Data collection interval (seconds).	1	no
	autodetection_retry	Autodetection retry interval (seconds). Set 0 to disable.	0	no
Target	address	Dnsmasq server address (`IP:PORT`).	127.0.0.1:53	yes
	protocol	DNS query transport protocol. Options: `udp`, `tcp`, `tcp-tls`.	udp	no
	timeout	DNS query timeout for dial, write, and read (seconds).	1	no
Virtual Node	vnode	Associates this data collection job with a Virtual Node.		no

</details>

via UI

Configure the dnsmasq collector from the Netdata web interface:

Go to Nodes.
Select the node where you want the dnsmasq data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
The Collectors → Jobs view opens by default.
In the Search box, type dnsmasq (or scroll the list) to locate the dnsmasq collector.
Click the + next to the dnsmasq collector to add a new job.
Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/dnsmasq.conf.

The file format is YAML. Generally, the structure is:

yaml

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/dnsmasq.conf

Examples

Basic

An example configuration.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 127.0.0.1:53

</details>

Using TCP protocol

Local server with specific DNS query transport protocol.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 127.0.0.1:53
    protocol: tcp

</details>

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 127.0.0.1:53

  - name: remote
    address: 203.0.113.0:53

</details>

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Dnsmasq instance

The metrics apply to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
dnsmasq.servers_queries	success, failed	queries/s
dnsmasq.cache_performance	hist, misses	events/s
dnsmasq.cache_operations	insertions, evictions	operations/s
dnsmasq.cache_size	size	entries

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the dnsmasq collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].
bash
```
cd /usr/libexec/netdata/plugins.d/
```
Switch to the netdata user.
bash
```
sudo -u netdata -s
```
Run the go.d.plugin to debug the collector:
bash
```
./go.d.plugin -d -m dnsmasq
```
To debug a specific job:
bash
```
./go.d.plugin -d -m dnsmasq -j jobName
```

Getting Logs

If you're encountering problems with the dnsmasq collector, follow these steps to retrieve logs and identify potential issues:

Run the command specific to your system (systemd, non-systemd, or Docker container).
Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

bash

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep dnsmasq

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

bash

grep dnsmasq /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

bash

docker logs netdata 2>&1 | grep dnsmasq