dnsmasq_dhcp

README

Dnsmasq DHCP monitoring with Netdata

Dnsmasq is a lightweight, easy to configure, DNS forwarder and DHCP server.

This module monitors Dnsmasq DHCP leases database.

Charts

It produces the following set of charts for every dhcp-range:

• DHCP Range Allocated Leases in leases
• DHCP Range Utilization in percentage

Auto-detection

Module automatically detects all configured dhcp-ranges reading dnsmasq configuration files.

By default it uses:

• /var/lib/misc/dnsmasq.leases to read leases.
• /etc/dnsmasq.conf to detect dhcp-ranges.
• /etc/dnsmasq.d to find additional configurations.

Configuration

Edit the go.d/dnsmasq_dhcp.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

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

Here is an example:

jobs:
  - name         : dnsmasq_dhcp
    leases_path  : /var/lib/misc/dnsmasq.leases
    conf_path    : /etc/dnsmasq.conf
    conf_dir     : /etc/dnsmasq.d

For all available options please see module configuration file.

Troubleshooting

Check the module debug output. Run the following command as netdata user:

./go.d.plugin -d -m dnsmasq_dhcp

Documentation

Index

• type Charts
• type Config
  • func (c Config) String() string
• type ConfigFinder
• type Dim
• type DnsmasqDHCP
  • func New() *DnsmasqDHCP
  • func (d DnsmasqDHCP) Charts() *Charts
  • func (d *DnsmasqDHCP) Check() bool
  • func (DnsmasqDHCP) Cleanup()
  • func (d *DnsmasqDHCP) Collect() map[string]int64
  • func (d *DnsmasqDHCP) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	LeasesPath string `yaml:"leases_path"`
	ConfPath   string `yaml:"conf_path"`
	ConfDir    string `yaml:"conf_dir"`
}

Config is the DnsmasqDHCP module configuration.

func (Config) String

func (c Config) String() string

type ConfigFinder

type ConfigFinder struct {
	// contains filtered or unexported fields
}

type Dim

type Dim = module.Dim

Dim is an alias for module.Dim

type DnsmasqDHCP

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

DnsmasqDHCP DnsmasqDHCP module.

func New

func New() *DnsmasqDHCP

New creates DnsmasqDHCP with default values.

func (DnsmasqDHCP) Charts

func (d DnsmasqDHCP) Charts() *Charts

Charts creates Charts.

func (*DnsmasqDHCP) Check

func (d *DnsmasqDHCP) Check() bool

Check makes check.

func (DnsmasqDHCP) Cleanup

func (DnsmasqDHCP) Cleanup()

Cleanup makes cleanup.

func (*DnsmasqDHCP) Collect

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

Collect collects metrics.

func (*DnsmasqDHCP) Init

func (d *DnsmasqDHCP) Init() bool

Init makes initialization.