Metadata-Version: 1.0
Name: kea-exporter
Version: 0.2.2
Summary: Export Kea Metrics in the Prometheus Exposition Format
Home-page: https://www.github.com/mweinelt/kea-exporter
Author: Martin Weinelt
Author-email: martin+keaexporter@linuxlounge.net
License: MIT
Description-Content-Type: UNKNOWN
Description: kea-exporter
        ============
        
        Prometheus Exporter for the ISC Kea DHCP Server.
        
        
        Installation
        ------------
        
        The latest stable version can be installed from PyPi:
        
        ::
        
            $ pip install kea-exporter
        
        
        and upgraded with:
        
        ::
        
            $ pip install --upgrade kea-exporter
        
        Features
        --------
        
        - DHCP4 & DHCP6 Metrics (tested against Kea 1.1.0 only)
        - Querying via control sockets
        - Automatic config reload (through inotify)
        
        
        Known Limitations
        -----------------
        
        - Include statements in Kea's configuration file are unsupported
        
        
        Usage
        -----
        
        ::
        
            Usage: kea-exporter [OPTIONS] CONFIG COMMAND [ARGS]...
        
            Options:
              --address TEXT      Specify the address to bind against.
              --port INTEGER      Specify the port on which to listen.
              --interval INTEGER  Specify the metrics update interval in seconds.
              --help              Show this message and exit.
        
        
        
        Configure Control Socket
        ////////////////////////
        
        The exporter uses Kea's control socket and the ``statistic-get-all`` request. Consult the documentation on how to set up
        the control socket:
        
        - http://kea.isc.org/docs/kea-guide.html#dhcp4-ctrl-channel
        - http://kea.isc.org/docs/kea-guide.html#dhcp6-ctrl-channel
        
        Permissions
        ///////////
        
        Kea Exporter needs to be able to read and write on the socket, hence it's permissions might need to be modified
        accordingly.
        
Platform: UNKNOWN
