nvitop-exporter
Prometheus exporter built on top of nvitop.
Quickstart
Start the exporter with the following command:
uvx nvitop-exporter --bind-address 0.0.0.0 --port 5050
# or
pipx run nvitop-exporter --bind-address 0.0.0.0 --port 5050
Then you can access the metrics at http://localhost:5050/metrics.
You will need to configure Prometheus to scrape the metrics from the exporter.
scrape_configs:
- job_name: 'nvitop-exporter'
static_configs:
- targets: ['localhost:5050']
TLS / mTLS
The exporter can serve metrics over HTTPS, optionally requiring client certificate authentication (mTLS). TLS support is provided by prometheus_client (>= 0.19.0) and configured entirely through CLI flags — no config file is involved.
Plain HTTPS
Provide a server certificate and private key:
nvitop-exporter --bind-address 0.0.0.0 --port 5050 \
--certfile /path/to/server.crt \
--keyfile /path/to/server.key
The metrics endpoint is then served at https://localhost:5050/metrics. Update the Prometheus scrape config to use the https scheme, and point it at the CA that signed your server certificate:
scrape_configs:
- job_name: 'nvitop-exporter'
scheme: https
static_configs:
- targets: ['localhost:5050']
tls_config:
ca_file: /path/to/server-ca.crt
Mutual TLS (mTLS)
To require scrapers to present a valid client certificate, pass a CA bundle (--client-cafile) or CA directory (--client-capath) and --client-auth-required:
nvitop-exporter --bind-address 0.0.0.0 --port 5050 \
--certfile /path/to/server.crt \
--keyfile /path/to/server.key \
--client-cafile /path/to/clients-ca.crt \
--client-auth-required
--client-cafile / --client-capath and --client-auth-required must be specified together. Passing a CA without --client-auth-required is rejected by the CLI to avoid the silent "trust but don't verify" configuration that the underlying prometheus_client API would otherwise allow.
Configure Prometheus to present its client certificate when scraping:
scrape_configs:
- job_name: 'nvitop-exporter'
scheme: https
static_configs:
- targets: ['localhost:5050']
tls_config:
ca_file: /path/to/server-ca.crt
cert_file: /path/to/prometheus-client.crt
key_file: /path/to/prometheus-client.key
Authentication beyond mTLS
The exporter does not implement HTTP basic auth, OAuth, or IP allowlisting. Following the standard Prometheus exporter pattern, run the exporter behind a reverse proxy (NGINX, Traefik, Caddy, ...) if any of those are required.
Grafana Dashboard
A Grafana dashboard is provided to visualize the metrics collected by the exporter.
The source of the dashboard is dashboard.json.
The Grafana dashboard can also be imported as by ID 22589.
If you are using docker-compose, you can start a dashboard at http://localhost:3000 with the following command:
cd nvitop-exporter/grafana
docker compose up --build --detach
The Grafana dashboard for the exporter.
Metadata
Release files for nvitop-exporter 1.7.2
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 |
|---|---|---|---|---|
| nvitop_exporter-1.7.2.tar.gz | 16.9 kB | Without provenance | Details for nvitop_exporter-1.7.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nvitop_exporter-1.7.2-py3-none-any.whl | Python 3 | none | any | Details for nvitop_exporter-1.7.2-py3-none-any.whl |
Total release size: 35.2 kB
Release files / nvitop_exporter-1.7.2.tar.gz
| Download URL | nvitop_exporter-1.7.2.tar.gz |
|---|---|
| Size | 16.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cbe8606266e72d7e809d1923bac6b307ed9874f661232670aff85ca49815d3eb
|
|
BLAKE2b-256 checksum How to use checksums |
a95c6ef57c62080355316b574686b26bd0819da3f5ff93d563010a5dc6e9b5c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / nvitop_exporter-1.7.2-py3-none-any.whl
| Download URL | nvitop_exporter-1.7.2-py3-none-any.whl |
|---|---|
| Size | 18.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
afeeb16c95ea8a8a6e7773b7fc23018bed801bec85554e8abfdff1bd677ecf0a
|
|
BLAKE2b-256 checksum How to use checksums |
06713a67fffec98b39e58c80fff9b9de401424b77063049f45b685b287a2d33b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for nvitop-exporter 1.7.2
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.