A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery
Project description
netbox-plugin-prometheus-sd
Provide Prometheus http_sd compatible API Endpoint with data from Netbox.
HTTP SD is a new feature in Prometheus 2.28.0 that allows hosts to be found via a URL instead of just files. This plugin implements API endpoints in Netbox to make devices, IPs and virtual machines available to Prometheus.
Compatibility
We aim to support the latest major versions of Netbox. For now we Support Netbox 2.11
, 3.0
and 3.1
including bugfix versions.
Netbox 3.2
has changed the datetime fields which is not compatible with the plugin code yet. As soon as we fixed this the plugin should work with 3.2
.
Installation
The plugin is available as a Python package in pypi and can be installed with pip
pip install netbox-plugin-prometheus-sd
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
PLUGINS = ['netbox_prometheus_sd']
The plugin has not further plugin configuration at the moment.
Usage
The plugin only provides a new API endpoint on the Netbox API. There is no further action required after installation.
API
The plugin reuses Netbox API view sets with new serializers for Prometheus. This means that all filters that can be used on the Netbox api can also be used to filter Prometheus targets. Paging is disabled because Prometheus does not support paged results.
The plugin also reuses the Netbox authentication and permission model. Depending on the Netbox configuration, a token with valid object permissions must be passed to Netbox.
GET /api/plugins/prometheus-sd/devices/ Get a list of devices in a prometheus compatible format
GET /api/plugins/prometheus-sd/virtual-machines/ Get a list of vms in a prometheus compatible format
GET /api/plugins/prometheus-sd/ip-addresses/ Get a list of ip in a prometheus compatible format
Example
A working example on how to use this plugin with Prometheus is located at the example
folder. Netbox content is created by using Netbox docker initializers.
The demo data doesn't make sense, but they are good enough for demonstrating how to configure Prometheus and get demo data to Prometheus service discovery.
Go to the example
folder and run docker-compose up
. Prometheus should get available on http://localhost:9090
. Netbox content should then be available in the service discovery tab.
Development
We use Poetry for dependency management and invoke as task runner. As Netbox plugins cannot be tested standalone, we need invoke to start all code embedded in Netbox Docker containers.
All code to run in docker is located under development
which is also the starting point for VScode remote containers (not finished yet).
To start a virtual env managed by poetry run poetry shell
.
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 netbox-plugin-prometheus-sd-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f9a22880c14b1a0c5cf279a17ba7b8f800aa66ea1eedb2736d5f450baa0a96e |
|
MD5 | 82027a49c35c8fdbe3ba8350b927b362 |
|
BLAKE2b-256 | 0ad2cf4898b73198d453707c307d6a812c1e98e680d072cb16c9b0464f0e0b09 |
Hashes for netbox_plugin_prometheus_sd-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26083850e0aa72d993aa4b98e6a001556657616bbc9856f6e1fe69edc56b731d |
|
MD5 | 21c62604fe2b303e217a1ef6d23f8ce5 |
|
BLAKE2b-256 | 9703eea3556c6b82b487b5fb518bd48eaca367a2f9ebafdcd0eb9df02f4cc136 |