illustris/pvemon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add README

Browse Source
This commit is contained in:
illustris 2023-10-02 14:21:14 +05:30
parent 23e6a59758
commit 511e55d269
Signed by: illustris
GPG Key ID: 56C8FC0B899FEFA3
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# PVEmon
PVEmon is a Prometheus exporter for Proxmox VE (PVE). Unlike prometheus-pve-exporter, this collects metrics locally from the host system instead of using the PVE API. This project is packaged using Nix.
## Features
- Collects and exports metrics about KVM virtual machines running on the local host.
- Metrics include CPU usage, memory usage, IO statistics, and more.
- Exports metrics at a `/metrics` HTTP endpoint for scraping by a Prometheus server.
- The Nix flake provides a `deb` build output for creating an installable package for PVE servers.
- Currently, the tool supports monitoring certain aspects of VMs. Support for LXC and additional VM metrics are planned for future releases.
## Installation
This project is packaged using Nix. To build a deb for your PVE servers, run:
```bash
nix build github:illustris/pvemon#deb
```