netbox-opentelemetry-plugin
netbox-opentelemetry-plugin exports NetBox telemetry (logs, audit records, traces and metrics) over OTLP to an OpenTelemetry Collector, directly from inside the NetBox processes (web workers, RQ workers, RQ work-horses). Each signal is an independent module, switched on or off in configuration.
Signals
| Signal | Default | Description |
|---|---|---|
| Logs | on | NetBox's Python logs, exported through the OTel Logs API. |
| Audit records | on | One structured record per ObjectChange (create, update, delete). |
| Traces | off | Spans for Django requests, PostgreSQL, Redis, outbound HTTP and RQ jobs. |
| Metrics | off | HTTP and job metrics, change counters, optional process runtime metrics. |
Screenshots
Taken in Grafana from the dev stack's ui profile (make dev-ui). Any OTLP backend works, through a Collector or with the exporter pointed at it directly.
Audit records in Loki, one per ObjectChange, with the change and the user as attributes, and the trace id of the request:
A REST API request trace in Tempo, with its PostgreSQL and Redis spans:
HTTP server request rate per route in Prometheus:
Compatibility
| Plugin | NetBox | Python |
|---|---|---|
| 0.1.x to 0.3.x | 4.7.0 to 4.7.x | 3.12, 3.13, 3.14 |
min_version = "4.7.0" and max_version = "4.7.99" in the plugin's PluginConfig enforce this NetBox range; NetBox refuses to load the plugin outside it.
Dependencies
Installing the package pulls in these OpenTelemetry packages, no others:
opentelemetry-api~= 1.44.0opentelemetry-sdk~= 1.44.0opentelemetry-exporter-otlp-proto-http~= 1.44.0opentelemetry-exporter-otlp-proto-grpc~= 1.44.0opentelemetry-instrumentation-django== 0.65b0opentelemetry-instrumentation-psycopg== 0.65b0opentelemetry-instrumentation-redis== 0.65b0opentelemetry-instrumentation-requests== 0.65b0opentelemetry-instrumentation-system-metrics== 0.65b0
No NetBox model, no database migration and no UI of its own.
Quick start
Install the package into the NetBox virtual environment:
source /opt/netbox/venv/bin/activate
pip install netbox-opentelemetry-plugin
netbox-docker's venv has no pip, only uv: use uv pip install netbox-opentelemetry-plugin in a custom image built on top of the upstream one. See the installation page for netbox-docker, the Helm chart, and bare metal gunicorn and uWSGI.
Enable the plugin in configuration.py:
PLUGINS = ["netbox_opentelemetry_plugin"]
PLUGINS_CONFIG = {
"netbox_opentelemetry_plugin": {
"exporter": {"endpoint": "http://otel-collector:4318"},
},
}
Turn on traces and metrics too:
PLUGINS_CONFIG = {
"netbox_opentelemetry_plugin": {
"exporter": {"endpoint": "http://otel-collector:4318"},
"traces": {"enabled": True},
"metrics": {"enabled": True},
},
}
Restart the NetBox web processes and the RQ workers to pick up the change.
Documentation
- Full documentation
- Installation
- Configuration reference
- Logs, audit records, traces, metrics
- How it works
- Data safety
- Failure behaviour
- Collector on Kubernetes
- Limitations
- Changelog
Licence
Apache 2.0. See the LICENSE file.
Metadata
Release files for netbox-opentelemetry-plugin 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| netbox_opentelemetry_plugin-0.3.1.tar.gz | 54.0 kB | With provenance | Details for netbox_opentelemetry_plugin-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| netbox_opentelemetry_plugin-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for netbox_opentelemetry_plugin-0.3.1-py3-none-any.whl |
Total release size: 111.9 kB
Release files / netbox_opentelemetry_plugin-0.3.1.tar.gz
| Download URL | netbox_opentelemetry_plugin-0.3.1.tar.gz |
|---|---|
| Size | 54.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
907d468a60a7c2959beb18f318cbf219d46e55554fcd9ba61d7d6c08990d1184
|
|
BLAKE2b-256 checksum How to use checksums |
1ffa9d2445aeb50e60b4112fb97f350a48e9db7d2239a3ef7ed48fb08a14e32f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / netbox_opentelemetry_plugin-0.3.1-py3-none-any.whl
| Download URL | netbox_opentelemetry_plugin-0.3.1-py3-none-any.whl |
|---|---|
| Size | 57.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
86fa827cff0f18169758e4b05549a387b9a5899cd09f4fd6628a4c4ac9e968d3
|
|
BLAKE2b-256 checksum How to use checksums |
2b8ce2d687acf453e959bcf9519087d8749bc46bde301f8dae0788308a26a358
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for netbox-opentelemetry-plugin 0.3.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for netbox_opentelemetry_plugin-0.3.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA 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.