DNSdist icon

DNSdist

DNSdist

Plugin: go.d.plugin Module: dnsdist

Overview

This collector monitors DNSDist 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

Prerequisites

Enable DNSdist built-in Webserver

For collecting metrics via HTTP, you need to enable the built-in webserver.

Configuration

File

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

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

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

Options

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

Name Description Default Required
update_every Data collection frequency. 1 False
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 False
url Server URL. http://127.0.0.1:8083 True
username Username for basic HTTP authentication. False
password Password for basic HTTP authentication. False
proxy_url Proxy URL. False
proxy_username Username for proxy basic HTTP authentication. False
proxy_password Password for proxy basic HTTP authentication. False
timeout HTTP request timeout. 1 False
method HTTP request method. GET False
body HTTP request body. False
headers HTTP request headers. False
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. False False
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. False False
tls_ca Certification authority that the client uses when verifying the server’s certificates. False
tls_cert Client tls certificate. False
tls_key Client tls key. False

Examples

Basic

An example configuration.

jobs:
  - name: local
    url: http://127.0.0.1:8083
    headers:
      X-API-Key: your-api-key # static pre-shared authentication key for access to the REST API (api-key).

Multi-instance

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

Collecting metrics from local and remote instances.

jobs:
  - name: local
    url: http://127.0.0.1:8083
    headers:
      X-API-Key: 'your-api-key' # static pre-shared authentication key for access to the REST API (api-key).

  - name: remote
    url: http://203.0.113.0:8083
    headers:
      X-API-Key: 'your-api-key'

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 DNSdist instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric Dimensions Unit
dnsdist.queries all, recursive, empty queries/s
dnsdist.queries_dropped rule_drop, dynamic_blocked, no_policy, non_queries queries/s
dnsdist.packets_dropped acl packets/s
dnsdist.answers self_answered, nxdomain, refused, trunc_failures answers/s
dnsdist.backend_responses responses responses/s
dnsdist.backend_commerrors send_errors errors/s
dnsdist.backend_errors timeouts, servfail, non_compliant responses/s
dnsdist.cache hits, misses answers/s
dnsdist.servercpu system_state, user_state ms/s
dnsdist.servermem memory_usage MiB
dnsdist.query_latency 1ms, 10ms, 50ms, 100ms, 1sec, slow queries/s
dnsdist.query_latency_avg 100, 1k, 10k, 1000k microseconds

Alerts

There are no alerts configured by default for this integration.

Troubleshooting

Debug Mode

To troubleshoot issues with the dnsdist 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].

    cd /usr/libexec/netdata/plugins.d/
    
  • Switch to the netdata user.

    sudo -u netdata -s
    
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m dnsdist
    

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo