A Python-based metrics collector for gathering and exporting hardware data from Proxmox hosts to InfluxDB. This tool provides detailed system metrics, including sensor data, NVMe/SATA device information, and VM disk usage statistics.
Note: This tool is a great alternative for those who prefer not to install Telegraf on their Proxmox host.
- System Metrics: Collect sensor data from Proxmox hosts.
- Device Monitoring: Monitor NVMe and SATA device metrics.
- VM Disk Usage Tracking: Fill gaps in Proxmox's native reporting by capturing detailed VM disk usage statistics.
- Flexible Configuration: Configure easily through environment variables or command-line options.
- Robust Logging: Leverage a comprehensive logging system for seamless debugging and monitoring.
- Python >= 3.11
- Access to a Proxmox host
- A running InfluxDB instance
Install the required dependencies using pip:
pip install "influxdb-client>=1.48.0" "python-dotenv>=1.0.1"Configure the script using the following environment variables:
| Variable | Description | Required |
|---|---|---|
HOST_NAME |
Proxmox host name | No |
INFLUX_URL |
InfluxDB server address | Yes |
INFLUX_TOKEN |
Authentication token | Yes |
INFLUX_ORG |
InfluxDB organization name | Yes |
INFLUX_BUCKET |
Target bucket name | Yes |
You can also store these environment variables in a .env file in the project directory. The python-dotenv library will automatically load them.
Run the script with default settings:
python pve_hardware_metrics.py-
Include VM Disk Metrics: Use this option to collect VM disk usage details that Proxmox’s
pvestatdmisses.python pve_hardware_metrics.py --vm-disk
-
Test Mode: Run the script without uploading data to InfluxDB.
python pve_hardware_metrics.py --test
-
Delete Specific Measurements: Remove older data and schemas in case of InfluxDB data type inconsistencies.
python pve_hardware_metrics.py --delete <measurement_name>
-
Help Menu: View all available options and flags.
python pve_hardware_metrics.py --help
InfluxDB can occasionally report data type conflicts. To resolve this, delete older measurements (and their associated schemas) using the --delete option. For example:
python pve_hardware_metrics.py --delete <measurement_name>This ensures the script can continue uploading data without issues.
SMART data reporting varies across devices. While this script has been tested on a wide range of NVMe and SATA devices, certain hardware configurations may require modifications to the script’s parsing logic.
If you encounter issues or discrepancies in reported data, please adjust the logic to match your specific hardware and let us know. Your feedback helps us improve compatibility and enhance the tool’s reliability.
Special thanks to MightySlaytanic for their work on Proxmox monitoring tools, which inspired this project.
This project is licensed under the MIT License. For details, refer to the LICENSE file.