Project: Netdata (Observability and Analysis / Observability)
File: unbound.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/unbound/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/unbound/metadata.yaml" sidebar_label: "Unbound" learn_status: "Published" learnrelpath: "Collecting Metrics/DNS and DHCP Servers" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/unbound.png" width="150"/> Plugin: go.d.plugin Module: unbound <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors Unbound servers. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | unbound.queries | queries | queries | | unbound.queriesipratelimited | ratelimited | queries | | unbound.dnscrypt_queries | crypted, cert, cleartext, malformed | queries | | unbound.cache | hits, miss | events | | unbound.cache_percentage | hits, miss | percentage | | unbound.prefetch | prefetches | prefetches | | unbound.expired | expired | replies | | unbound.zerottlreplies | zero_ttl | replies | | unbound.recursive_replies | recursive | replies | | unbound.recursion_time | avg, median | milliseconds | | unbound.requestlistusage | avg, max | queries | | unbound.currentrequestlist_usage | all, users | queries | | unbound.requestlistjostle_list | overwritten, dropped | queries | | unbound.tcpusage | usage | buffers | | unbound.uptime | time | seconds | | unbound.cachememory | message, rrset, dnscryptnonce, dnscryptsharedsecret | KB | | unbound.mod_memory | iterator, respip, validator, subnet, ipsec | KB | | unbound.mem_streamwait | streamwait | KB | | unbound.cachecount | infra, key, msg, rrset, dnscryptnonce, shared_secret | items | | unbound.type_queries | a dimension per query type | queries | | unbound.class_queries | a dimension per query class | queries | | unbound.opcode_queries | a dimension per query opcode | queries | | unbound.flag_queries | qr, aa, tc, rd, ra, z, ad, cd | queries | | unbound.rcode_answers | a dimension per reply rcode | replies | These metrics refer to threads. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | unbound.thread_queries | queries | queries | | unbound.threadqueriesip_ratelimited | ratelimited | queries | | unbound.threaddnscryptqueries | crypted, cert, cleartext, malformed | queries | | unbound.thread_cache | hits, miss | events | | unbound.threadcachepercentage | hits, miss | percentage | | unbound.thread_prefetch | prefetches | prefetches | | unbound.thread_expired | expired | replies | | unbound.threadzerottlreplies | zerottl | replies | | unbound.threadrecursivereplies | recursive | replies | | unbound.threadrecursiontime | avg, median | milliseconds | | unbound.threadrequestlist_usage | avg, max | queries | |

| all, users | queries | | unbound.threadrequestlistjostlelist | overwritten, dropped | queries | | unbound.thread_tcpusage | usage | buffers | There are no alerts configured by default for this integration. Set `control-enable` to yes in . If using unix socket: socket should be readable and writeable by `netdata` user If using ip socket and TLS is disabled: socket should be accessible via network If TLS is enabled, in addition: `control-key-file` should be readable by `netdata` user `control-cert-file` should be readable by `netdata` user For auto-detection parameters from `unbound.conf`: `unbound.conf` should be readable by `netdata` user if you have several configuration files (include feature) all of them should be readable by `netdata` user The configuration file name for this integration is `go.d/unbound.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/unbound.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | address | Server address in IP:PORT format. | 127.0.0.1:8953 | yes | | timeout | Connection/read/write/ssl handshake timeout. | 1 | no | | conf_path | Absolute path to the unbound configuration file. | /etc/unbound/unbound.conf | no | | cumulative_stats | Statistics collection mode. Should have the same value as the `statistics-cumulative` parameter in the unbound configuration file. | no | no | | use_tls | Whether to use TLS or not. | yes | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | yes | no | | tls_ca | Certificate authority that client use when verifying server certificates. | | no | | tlscert | Client tls certificate. | /etc/unbound/unboundcontrol.pem | no | | tlskey | Client tls key. | /etc/unbound/unboundcontrol.key | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:8953 ``` </details> Connecting through Unix socket. <details><summary>Config</summary> ```yaml jobs: name: socket address: /var/run/unbound.sock ``` </details> Note: When you define multiple jobs, their names must be unique. Local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:8953 name: remote address: 203.0.113.11:8953 ``` </details> To troubleshoot issues with the `unbound` 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 unbound ```