unbound-telemetry

Unbound DNS resolver metrics exporter for Prometheus

Deprecation notice

This repo is archived and will not be maintained anymore. You can use the unbound_exporter by Let's Encrypt instead.

Features

* Communicates with unbound via TLS, UDS socket or shared memory * Compatible with kumina/unbound_exporter; your dashboard should just work * Small binary size (~2 Mb after strip) and memory footprint (~10 Kb) * Takes ~10 ms to respond with gathered metrics * Blazing fast!

Platform support

This project is developed, manually and automatically tested with Linux.

Following platforms are tested in the CI environment and expected to work:

* Windows * macOS

It is expected that FreeBSD, NetBSD and OpenBSD will work too, but there are no any manual or automatic checks for them exist.

Note that communication via UDS socket or shared memory is not supported for Windows.

Installation

From sources

Rust language compiler version >= 1.46 is required
Clone the repository
Run the following command

$ cargo build --release

Get the compiled executable from the ./target/release/unbound-telemetry

Usage

HTTP interface is available at http://0.0.0.0:9167 by default and can be changed via CLI arguments.

TCP socket

First of all, enable remote-control option in the unbound.conf, configure control interface address and TLS if needed.

Run the following command to see possible flags and options:

$ unbound-telemetry tcp --help

Unix domain socket

Similar to TLS socket, you need to enable remote-control option first.

Run the following command to see possible flags and options:

$ unbound-telemetry uds --help

Shared memory

Enable shm-enable option in the unbound.conf and run the following command:

$ unbound-telemetry shm --help

Monitoring

/healthcheck URL can be used for automated monitoring; in case when exporter is not able to access the unbound instance, HTTP 500 error will be returned, response body will contain plain text error description.