nvitop-exporter


Namenvitop-exporter JSON
Version 1.5.2 PyPI version JSON
download
home_pageNone
SummaryPrometheus exporter built on top of `nvitop`.
upload_time2025-07-25 08:12:27
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseApache-2.0
keywords nvidia nvidia-smi nvidia nvml cuda gpu top monitoring prometheus prometheus grafana grafana
VCS
bugtrack_url
requirements nvidia-ml-py psutil colorama windows-curses
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # nvitop-exporter

Prometheus exporter built on top of `nvitop`.

## Quickstart

Start the exporter with the following command:

```bash
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`](http://localhost:5050/metrics).

You will need to configure Prometheus to scrape the metrics from the exporter.

```yaml
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`](grafana/dashboard.json).
The Grafana dashboard can also be imported as by ID [22589](https://grafana.com/grafana/dashboards/22589-nvitop-dashboard).

If you are using [`docker-compose`](https://docs.docker.com/compose), you can start a dashboard at [`http://localhost:3000`](http://localhost:3000) with the following command:

```bash
cd nvitop-exporter/grafana
docker compose up --build --detach
```

<p align="center">
  <img width="100%" src="https://github.com/user-attachments/assets/e4867e64-2ca9-45bc-b524-929053f9673d" alt="Grafana Dashboard">
  <br/>
  The Grafana dashboard for the exporter.
</p>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nvitop-exporter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "nvidia, nvidia-smi, NVIDIA, NVML, CUDA, GPU, top, monitoring, prometheus, Prometheus, grafana, Grafana",
    "author": null,
    "author_email": "Xuehai Pan <XuehaiPan@pku.edu.cn>",
    "download_url": "https://files.pythonhosted.org/packages/be/b1/c0d7e82c5a7d3a524697b58dda0ec8c2eb0faa674eea25acacc8b003ca0c/nvitop_exporter-1.5.2.tar.gz",
    "platform": null,
    "description": "# nvitop-exporter\n\nPrometheus exporter built on top of `nvitop`.\n\n## Quickstart\n\nStart the exporter with the following command:\n\n```bash\nuvx nvitop-exporter --bind-address 0.0.0.0 --port 5050\n# or\npipx run nvitop-exporter --bind-address 0.0.0.0 --port 5050\n```\n\nThen you can access the metrics at [`http://localhost:5050/metrics`](http://localhost:5050/metrics).\n\nYou will need to configure Prometheus to scrape the metrics from the exporter.\n\n```yaml\nscrape_configs:\n  - job_name: 'nvitop-exporter'\n    static_configs:\n      - targets: ['localhost:5050']\n```\n\n## Grafana Dashboard\n\nA Grafana dashboard is provided to visualize the metrics collected by the exporter.\nThe source of the dashboard is [`dashboard.json`](grafana/dashboard.json).\nThe Grafana dashboard can also be imported as by ID [22589](https://grafana.com/grafana/dashboards/22589-nvitop-dashboard).\n\nIf you are using [`docker-compose`](https://docs.docker.com/compose), you can start a dashboard at [`http://localhost:3000`](http://localhost:3000) with the following command:\n\n```bash\ncd nvitop-exporter/grafana\ndocker compose up --build --detach\n```\n\n<p align=\"center\">\n  <img width=\"100%\" src=\"https://github.com/user-attachments/assets/e4867e64-2ca9-45bc-b524-929053f9673d\" alt=\"Grafana Dashboard\">\n  <br/>\n  The Grafana dashboard for the exporter.\n</p>\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Prometheus exporter built on top of `nvitop`.",
    "version": "1.5.2",
    "project_urls": {
        "Bug Report": "https://github.com/XuehaiPan/nvitop/issues",
        "Documentation": "https://nvitop.readthedocs.io",
        "Homepage": "https://github.com/XuehaiPan/nvitop",
        "Repository": "https://github.com/XuehaiPan/nvitop"
    },
    "split_keywords": [
        "nvidia",
        " nvidia-smi",
        " nvidia",
        " nvml",
        " cuda",
        " gpu",
        " top",
        " monitoring",
        " prometheus",
        " prometheus",
        " grafana",
        " grafana"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b60bce14a17b707eca65ae122ac586557c1b192f9599bb639820e724058eb398",
                "md5": "3b1100a983208218abfda9d2b4d21fc6",
                "sha256": "36bd8c8e3ecf6e398a2ef7cd430d68a9c550e78a29b07415b8b5e356cb8050d2"
            },
            "downloads": -1,
            "filename": "nvitop_exporter-1.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b1100a983208218abfda9d2b4d21fc6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16783,
            "upload_time": "2025-07-25T08:12:25",
            "upload_time_iso_8601": "2025-07-25T08:12:25.494305Z",
            "url": "https://files.pythonhosted.org/packages/b6/0b/ce14a17b707eca65ae122ac586557c1b192f9599bb639820e724058eb398/nvitop_exporter-1.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "beb1c0d7e82c5a7d3a524697b58dda0ec8c2eb0faa674eea25acacc8b003ca0c",
                "md5": "dff2403fafc76f9e3121f8bfcb58f18a",
                "sha256": "7de76efa6e245bde0c9eb8961387499fd3227ac3505160c9dac6c47d7f054241"
            },
            "downloads": -1,
            "filename": "nvitop_exporter-1.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "dff2403fafc76f9e3121f8bfcb58f18a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14735,
            "upload_time": "2025-07-25T08:12:27",
            "upload_time_iso_8601": "2025-07-25T08:12:27.658855Z",
            "url": "https://files.pythonhosted.org/packages/be/b1/c0d7e82c5a7d3a524697b58dda0ec8c2eb0faa674eea25acacc8b003ca0c/nvitop_exporter-1.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-25 08:12:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "XuehaiPan",
    "github_project": "nvitop",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "nvidia-ml-py",
            "specs": [
                [
                    "<",
                    "12.576.0a0"
                ],
                [
                    ">=",
                    "11.450.51"
                ]
            ]
        },
        {
            "name": "psutil",
            "specs": [
                [
                    ">=",
                    "5.6.6"
                ]
            ]
        },
        {
            "name": "colorama",
            "specs": [
                [
                    ">=",
                    "0.4.0"
                ]
            ]
        },
        {
            "name": "windows-curses",
            "specs": [
                [
                    ">=",
                    "2.2.0"
                ]
            ]
        }
    ],
    "lcname": "nvitop-exporter"
}
        
Elapsed time: 0.97662s