Skip to main content

fork to try this plugin nautobot compatible

netbox-plugin-prometheus-sd

License: MIT CI PyPI

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, 3.1, 3.2 and 3.3 including bugfix versions. All relevant target versions are tested in CI. Have a look at the Github Actions definition for the current build targets.

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. To start a virtual env managed by poetry run poetry shell. All following commands are started inside this environment.

In order to run tests invoke the test steps

# Execute all tests
invoke tests

# Execute unit tests only
invoke unittest

Features should be covered by a unit test, but some times it's easier to develop on an running system.

# Start a local Netbox with docker
invoke start

# Create an user named `admin`
invoke create-user

Visit http://localhost:8000 and log in with the new user. You can now define Netbox entities and test around.

API endpoints for testing can be found at http://localhost:8000/api/plugins/prometheus-sd/

Metadata

Release files for nautobot-plugin-prometheus-sd 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nautobot-plugin-prometheus-sd 0.0.1
File Size Uploaded Provenance Actions
nautobot_plugin_prometheus_sd-0.0.1.tar.gz 10.3 kB Without provenance Details for nautobot_plugin_prometheus_sd-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nautobot-plugin-prometheus-sd 0.0.1
File Interpreter ABI Platform Actions
nautobot_plugin_prometheus_sd-0.0.1-py3-none-any.whl Python 3 none any Details for nautobot_plugin_prometheus_sd-0.0.1-py3-none-any.whl

Total release size: 21.8 kB

Release files / nautobot_plugin_prometheus_sd-0.0.1.tar.gz

Download URL nautobot_plugin_prometheus_sd-0.0.1.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
783399d27e6964d51c3b3e21d78b7deb6cf1913609d6827ded304d7e353e5586
BLAKE2b-256 checksum
How to use checksums
3a7520e5ce832ce2ad6fb090e636b3923b040a966f943c8f310b51e42676fc1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.10.8 Linux/6.0.8-arch1-1

Release files / nautobot_plugin_prometheus_sd-0.0.1-py3-none-any.whl

Download URL nautobot_plugin_prometheus_sd-0.0.1-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cdb315c7f7b652ddd61859af902c14b2c8bba5989d12e3e283016f26072020ee
BLAKE2b-256 checksum
How to use checksums
5ab6a640691bc113b119ab5f60a79af38bc2b0f55d1c46e5bc89cf5b62a51c8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.10.8 Linux/6.0.8-arch1-1

Security for nautobot-plugin-prometheus-sd 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page