1.. _stork:
2
3*************************
4Monitoring Kea With Stork
5*************************
6
7Most administrators want to be able to monitor any Kea services that are running. Kea offers so many
8pieces of information - configuration files, API, statistics, logs, open database content, and more -
9that it may sometimes
10be overwhelming to keep up. ISC's Stork project is intended to address this problem for both Kea
11and BIND 9. Stork is useful in a variety of scenarios:
12
13- Stork can be used as a dashboard. It provides insight into what exactly is happening
14  on the servers. In particular, it allows users to: see up-to-date details regarding pool
15  utilization in subnets and shared networks; monitor the state of the HA pair (and
16  provide extra insight in case of failover and recovery events); list, filter, and
17  search for specific host reservations; and more. Only
18  a single Stork server needs to be deployed, and one Stork agent on each machine to be monitored.
19
20- The Stork agent can integrate Kea with Prometheus and Grafana. Once the Stork
21  agent is active on the server, it serves as a Prometheus exporter. Users who have deployed
22  Prometheus in their networks can visualize statistics as time series using Grafana.
23
24- Stork can act as both a dashboard and an integrator for Prometheus/Grafana. Once Stork
25  is linked to where Grafana is deployed on the network, users can inspect the current status and
26  visit a customized link to Grafana to see how a given property behaves over time.
27
28Stork is available as source code, but also as native deb and RPM packages, which makes it easy
29to install on most popular systems. For more details, please see the
30`Stork ARM <https://stork.readthedocs.io>`_ or the `Stork project page <https://gitlab.isc.org/isc-projects/stork>`_.
31The former has a nice collection of screenshots that is frequently updated, to give users
32an idea of what is currently available. Stork is in the midst of full development with
33monthly releases, so please check back frequently.
34
35.. _grafana:
36.. _prometheus:
37
38Kea Statistics in Grafana
39=========================
40
41The ISC Stork project provides an agent that can be deployed alongside Kea and BIND 9. It
42exposes Kea statistics in a format that is accepted by Prometheus.
43One of the major benefits of Prometheus is that it turns repeated one-time observations into time series,
44which lets users monitor how certain behaviors change over time. It is easy to use other tools
45to visualize data available in Prometheus; the most common approach is to use
46Grafana to provide visual dashboards. The Stork project provides dashboard
47definitions for Kea and BIND 9 that can be imported into Grafana very easily.
48
49Learn more about Prometheus and Grafana on their websites: `Prometheus <https://prometheus.io/>`
50and `Grafana <https://grafana.com/>`.
51