dnsdist

README

DNSdist monitoring with Netdata

DNSdist is a highly DNS-, DoS- and abuse-aware loadbalancer.

This module monitors load-balancer performance and health metrics.

It collects metrics from the internal webserver.

Used endpoints:

• /jsonstat?command=stats.

Requirements

For collecting metrics via HTTP, we need enabled webserver.

Metrics

All metrics have "dnsdist." prefix.

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

Configuration

Edit the go.d/dnsdist.conf configuration file using edit-config from the Agent's config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/dnsdist.conf

Needs url and password or apikey to access the webserver.

Here is a configuration example:

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' # static pre-shared authentication key for access to the REST API (api-key).

For all available options, see the dnsdist collector's configuration file.

Troubleshooting

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
  

Documentation

Index

• type Config
• type DNSdist
  • func New() *DNSdist
  • func (d *DNSdist) Charts() *module.Charts
  • func (d *DNSdist) Check() bool
  • func (d *DNSdist) Cleanup()
  • func (d *DNSdist) Collect() map[string]int64
  • func (d *DNSdist) Init() bool

Types

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

type DNSdist

type DNSdist struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *DNSdist

func (*DNSdist) Charts

func (d *DNSdist) Charts() *module.Charts

func (*DNSdist) Check

func (d *DNSdist) Check() bool

func (*DNSdist) Cleanup

func (d *DNSdist) Cleanup()

func (*DNSdist) Collect

func (d *DNSdist) Collect() map[string]int64

func (*DNSdist) Init

func (d *DNSdist) Init() bool