Export Kea Metrics in the Prometheus Exposition Format
Project description
kea-exporter
Prometheus Exporter for the ISC Kea DHCP Server.
From v0.4.0 on Kea >=1.3.0 is required, as the configuration, specifically subnet information, will be read from the control socket.
Installation
The latest stable version can always be installed from PyPi:
$ pip install kea-exporter
and upgraded with:
$ pip install --upgrade kea-exporter
Docker
A docker image is available and can be configured with environment variables see usage section
$ docker pull ghcr.io/mweinelt/kea-exporter
Features
DHCP4 & DHCP6 Metrics (tested against Kea 2.4.1)
Configuration and statistics via control socket or http api
Currently not working:
Automatic config reload (through inotify)
Known Limitations
The following features are not supported yet, help is welcome.
Shared Networks
Custom Subnet Identifiers
Usage
Usage: kea-exporter [OPTIONS] [SOCKETS]... Options: -m, --mode [socket|http] Select mode. -a, --address TEXT Specify the address to bind against. -p, --port INTEGER Specify the port on which to listen. -i, --interval INTEGER Minimal interval between two queries to Kea in seconds. -t, --target TEXT Target address and port of Kea server, e.g. http://kea.example.com:8080. --client-cert TEXT Client certificate file path used in HTTP mode with mTLS --client-key TEXT Client key file path used in HTTP mode with mTLS --version Show the version and exit. --help Show this message and exit.
You can also configure the exporter using environment variables:
export MODE="http" export ADDRESS="0.0.0.0" export PORT="9547" export INTERVAL="7.5" export TARGET="http://kea" export CLIENT_CERT="/etc/kea-exporter/client.crt" export CLIENT_KEY="/etc/kea-exporter/client.key"
Configure Control Socket
The exporter uses Kea’s control socket to request both configuration and statistics. Consult the documentation on how to set up the control socket:
HTTPS
If you need to validate a self-signed certificate on a Kea instance, you can set REQUESTS_CA_BUNDLE environment variable to a bundle CA path.
Permissions
Kea Exporter needs to be able to read and write on the socket, hence it’s permissions might need to be modified accordingly.
Grafana-Dashboard
A dashboard for this exporter is available at https://grafana.com/grafana/dashboards/12688.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kea_exporter-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02c73da3b6917fe631063395063e58b9b9c0f758f09a44139277b966710515e3 |
|
MD5 | 20f42137c777a3b5b614cc86280f46ca |
|
BLAKE2b-256 | e04b25daae241b1bb0ac7c053283604c4109bfc128d222b5fdbb991df69722f8 |