Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rupeshtr78/nvidia-metrics-prometheus
Collect and export NVIDIA GPU metrics and labels to Prometheus
https://github.com/rupeshtr78/nvidia-metrics-prometheus
golang gpu grafana metrics monitoring nivida prometheus
Last synced: 13 days ago
JSON representation
Collect and export NVIDIA GPU metrics and labels to Prometheus
- Host: GitHub
- URL: https://github.com/rupeshtr78/nvidia-metrics-prometheus
- Owner: rupeshtr78
- License: mit
- Created: 2024-05-12T22:13:15.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-20T22:15:05.000Z (7 months ago)
- Last Synced: 2024-11-13T08:27:56.929Z (2 months ago)
- Topics: golang, gpu, grafana, metrics, monitoring, nivida, prometheus
- Language: Go
- Homepage:
- Size: 420 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nvidia Metrics
The repository, `nvidia-metrics`, leverages the Nvidia Management Library (NVML), a C-based API that can interface with Nvidia GPUs. This repository gives a clear insight into the usage statistics of Nvidia GPUs like temperature, power consumption, memory usage, etc. It is intended for developers working on high performance computing, machine learning, and other GPU-intensive tasks. The gathered metrics are transmitted to Prometheus and Grafana for visualization. You can utilize the `config/metrics.yaml` file to specify and modify the metrics that are required. This YAML configuration file allows you to define and adjust metrics and labels.
## Getting Started
These instructions will provide you a guideline for installing prerequisites, running the application, and building necessary files.
Usage
```
-config string
Path to the configuration file (default "config/metrics.yaml")
-filelog string
Enable file logging (default "false")
-host string
Host to run the metrics server (default "0.0.0.0")
-interval string
Time interval in seconds to scrape metrics (default "5")
-logfile string
Log file path (default "logs/gpu-metrics.log")
-loglevel string
Log level (debug, info, warn, error,fatal) (default "info")
-port string
Port to run the metrics server (default "9500")
```
### Prerequisites
To use this repository, you should have the Nvidia CUDA toolkit installed on your system.
You can install the toolkit via:
```bash
sudo apt-get install nvidia-cuda-toolkit
```
### Installing & Running the application
Clone the repository to your local machine.
```bash
git clone
```
Navigate to the cloned directory.
```bash
cd nvidia-metrics
```
Compile the project.
```bash
make
```
After the project has been compiled, run the resulting binary.
```bash
./nvidiaMetrics --config config/metrics.yaml
```
```bash
docker run -e CONFIG_FILE=/path/to/config.yaml \
-e LOG_LEVEL=debug \
-e PORT=8080 \
-e HOST=0.0.0.0 \
-e INTERVAL=10 \
your-image-name
```
## Built With
- NVML - A C-based GO API for monitoring and managing Nvidia GPUs.
- CUDA - A parallel computing platform and programming model developed by Nvidia for general computing on GPUs.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
## License
This project is licensed under the MIT License.
## Contact
Please feel free to contact the project maintainers if you encounter any issues or have any enquiries about the repository.
We hope you find this repository useful in your venture!