knot_exporter icon indicating copy to clipboard operation
knot_exporter copied to clipboard

Prometheus exporter for Knot DNS

knot_exporter

knot_exporter is a Prometheus exporter for Knot_'s server and query statistics.

.. _Knot: https://www.knot-dns.cz/

Getting Started

knot_exporter uses Knot's control unix socket, so Knot has to be installed on the same machine as knot_exporter, and knot_exporter must be executed by a user with access to Knot's socket path.

The Knot instance also needs to be configured to collect per-zone query statistic. This can be done by enabling and configuring the stats module_.

.. _stats module: https://www.knot-dns.cz/docs/2.6/html/modules.html?highlight=mod%20stats#stats-query-statistics

Once everything is in place, knot_exporter can be started like so:

.. code-block:: bash

$ ./knot_exporter --knot-library-path /path/to/libknot.so

To get a complete list of the available options, run:

.. code-block:: bash

$ ./knot_exporter --help

Copyright

Copyright (C) 2018 Alessandro Ghedini [email protected]

Copyright (C) 2018 CZ.NIC, z.s.p.o. [email protected]

The Python bindings for libknot were adapted from the code available in the official Knot repo_.

See COPYING_ for the license.

.. _COPYING: https://github.com/ghedo/pflask/tree/master/COPYING .. _Knot repo: https://github.com/CZ-NIC/knot/blob/master/python/libknot/control.py