RepoMirrors
/
unbound_exporter
mirror of https://github.com/letsencrypt/unbound_exporter
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README with deployment models (#64)

This commit is contained in:
Jacob Hoffman-Andrews 2023-11-13 16:54:00 -08:00 committed by GitHub
parent ed237708aa
commit 1de6c94faa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -11,7 +11,7 @@ names and labels by using a set of regular expressions.
# Prerequisites
Go 1.16 or above is required.
Go 1.20 or above is required.
# Installation
@ -29,18 +29,33 @@ go mod tidy
- - - -
# Usage
# Usage - Unix socket
To show all CLI flags available
The simplest way to run unbound_exporter is on the same machine as your Unbound instance, connecting via a Unix socket. First, make sure you have this in your unbound.conf:
$ unbound_exporter -h
remote-control:
control-enable: yes
control-interface: /run/unbound.ctl
Scrape metrics from the exporter
Then, arrange to run this on the same machine:
unbound_exporter -unbound.ca "" -unbound.cert "" -unbound.host "unix:///run/unbound.ctl"
Metrics will be exported under /metrics, on port 9167, on all interfaces.
$ curl 127.0.0.1:9167/metrics | grep '^unbound_up'
unbound_up 1
# Usage - TLS
The more complicated way to run unbound_exporter is to configure unbound's control-interface with a TLS certificate from a private CA, and run unbound_exporter on a separate host. This is more of a hassle because you have to keep the certificate up to date and distribute the private CA to the host that unbound_exporter runs on.
See https://unbound.docs.nlnetlabs.nl/en/latest/getting-started/configuration.html#set-up-remote-control for instructions on setting up the certificates and keys for remote-control via TLS. On the unbound_exporter side you will need to set the `-unbound.ca`, `-unbound.cert`, and `-unbound.key` flags to point to valid files that will trust the Unbound server's certificate and be trusted by Unbound in return.
# Extended statistics
From the Unbound [statistics doc](https://www.nlnetlabs.nl/documentation/unbound/howto-statistics/): Unbound has an option to enable extended statistics collection. If enabled, more statistics are collected, for example what types of queries are sent to the resolver. Otherwise, only the total number of queries is collected. Add the following to your `unbound.conf`.
server:
extended-statistics: yes