github-starred/nvitop
2
0
Fork 0
mirror of https://github.com/XuehaiPan/nvitop.git synced 2026-05-15 14:15:55 -06:00
Code Issues 29 Projects Packages Wiki Activity Actions
nvitop/nvitop-exporter
History
Xuehai Pan 07c4819e1b chore(exporter): build nvitop-exporter docker image with local source code
2025-11-12 13:01:09 +08:00
..
grafana feat(workflows/docker): add workflow to build docker images (#191) 2025-11-11 15:57:18 +08:00
nvitop_exporter ver: bump version to v1.6.0 2025-11-11 15:59:54 +08:00
Dockerfile chore(exporter): build nvitop-exporter docker image with local source code 2025-11-12 13:01:09 +08:00
LICENSE chore: update license header 2025-01-18 23:25:18 +08:00
pyproject.toml ver: bump version to v1.6.0 2025-11-11 15:59:54 +08:00
README.md docs: prefer uvx over pipx in docs 2025-07-25 00:13:21 +08:00
requirements.txt ver: bump version to v1.4.1 2025-01-13 17:59:21 +08:00
setup.py chore(pre-commit): update pre-commit hooks 2025-04-20 00:10:40 +08:00

README.md

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']

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

Grafana Dashboard
The Grafana dashboard for the exporter.