.. SPDX-License-Identifier: GPL-3.0-or-later
.. _mod-graphite:
Graphite/InfluxDB/Metronome
---------------------------
The ``graphite`` sends statistics over the Graphite_ protocol to either Graphite_, Metronome_, InfluxDB_ or any compatible storage. This allows powerful visualization over metrics collected by Knot Resolver.
.. tip:: The Graphite server is challenging to get up and running, InfluxDB_ combined with Grafana_ are much easier, and provide richer set of options and available front-ends. Metronome_ by PowerDNS alternatively provides a mini-graphite server for much simpler setups.
Example configuration:
Only the ``host`` parameter is mandatory.
By default the module uses UDP so it doesn't guarantee the delivery, set ``tcp = true`` to enable Graphite over TCP. If the TCP consumer goes down or the connection with Graphite is lost, resolver will periodically attempt to reconnect with it.
.. code-block:: lua
modules = {
graphite = {
prefix = hostname() .. worker.id, -- optional metric prefix
host = '127.0.0.1', -- graphite server address
port = 2003, -- graphite server port
interval = 5 * sec, -- publish interval
tcp = false -- set to true if you want TCP mode
}
}
The module supports sending data to multiple servers at once.
.. code-block:: lua
modules = {
graphite = {
host = { '127.0.0.1', '1.2.3.4', '::1' },
}
}
Dependencies
^^^^^^^^^^^^
* `lua cqueues <https://25thandclement.com/~william/projects/cqueues.html>`_ package.
.. _Graphite: https://graphite.readthedocs.io/en/latest/feeding-carbon.html
.. _InfluxDB: https://influxdb.com/
.. _Metronome: https://github.com/ahuPowerDNS/metronome
.. _Grafana: http://grafana.org/
