Proxmox VE exporter for the Prometheus monitoring system.
Project description
Prometheus Proxmox VE Exporter
This is an exporter that exposes information gathered from Proxmox VE node for use by the Prometheus monitoring system.
Installation
Note: Python 2 is not supported anymore as of version 2.0.0. Instead use Python 3.6 or better.
Using pip:
python3 -m pip install prometheus-pve-exporterUsing docker:
docker pull prompve/prometheus-pve-exporterExample: Display usage message:
docker run -it --rm prompve/prometheus-pve-exporter --helpExample: Run the image with a mounted configuration file and published port:
docker run --name prometheus-pve-exporter -d -p 127.0.0.1:9221:9221 -v /path/to/pve.yml:/etc/pve.yml prompve/prometheus-pve-exporterPrometheus PVE Exporter will now be reachable at http://localhost:9090/.
Usage
usage: pve_exporter [-h] [config] [port] [address] positional arguments: config Path to configuration file (pve.yml) port Port on which the exporter is listening (9221) address Address to which the exporter will bind optional arguments: -h, --help show this help message and exit
Use :: for the address argument in order to bind to both IPv6 and IPv4 sockets on dual stacked machines.
Visit http://localhost:9221/pve?target=1.2.3.4 where 1.2.3.4 is the IP of the Proxmox VE node to get metrics from. Specify the module request parameter, to choose which module to use from the config file.
The target request parameter defaults to localhost. Hence if pve_exporter is deployed directly on the proxmox host, target can be omitted.
See the wiki for more examples and docs.
Authentication
Example pve.yml for password authentication:
default:
user: prometheus@pve
password: sEcr3T!Example pve.yml for token authentication:
default:
user: prometheus@pve
token_name: "..."
token_value: "..."The configuration is passed directly into proxmoxer.ProxmoxAPI().
Note: When operating PVE with self-signed certificates, then it is necessary to either import the certificate into the local trust store (see this SE answer for Debian/Ubuntu) or add verify_ssl: false to the config dict as a sibling to the credentials. Note that PVE supports Let’s Encrypt out ouf the box. In many cases setting up trusted certificates is the better option than operating with self-signed certs.
Proxmox VE Configuration
For security reasons it is essential to add a user with read-only access (PVEAuditor role) for the purpose of metrics collection.
Prometheus Configuration
The PVE exporter can be deployed either directly on a Proxmox VE node or onto a separate machine.
Example config for PVE exporter running on PVE node:
scrape_configs:
- job_name: 'pve'
static_configs:
- targets:
- 192.168.1.2:9221 # Proxmox VE node with PVE exporter.
- 192.168.1.3:9221 # Proxmox VE node with PVE exporter.
metrics_path: /pve
params:
module: [default]Example config for PVE exporter running on Prometheus host:
scrape_configs:
- job_name: 'pve'
static_configs:
- targets:
- 192.168.1.2 # Proxmox VE node.
- 192.168.1.3 # Proxmox VE node.
metrics_path: /pve
params:
module: [default]
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: 127.0.0.1:9221 # PVE exporter.Grafana Dashboards
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file prometheus-pve-exporter-2.0.3.tar.gz.
File metadata
- Download URL: prometheus-pve-exporter-2.0.3.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 403b2aa5a1c783f922079205a44c682487c0a116e76f85234de2bc386c025674 |
|
| MD5 | d286aab5cdfafdfe9bd83176b00c4389 |
|
| BLAKE2b-256 | 76c469f01a537e725878cfdb1c2e2f6d186be6d2ccf2ba865a668abd2fa99083 |
File details
Details for the file prometheus_pve_exporter-2.0.3-py3-none-any.whl.
File metadata
- Download URL: prometheus_pve_exporter-2.0.3-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 022b2598a08ddd8040058491b431292fe24cb7a8109e0c146f137f8999aa7f1e |
|
| MD5 | 465f7680fd4b7883afaad4f8d4cdcd73 |
|
| BLAKE2b-256 | eb32cffacab14fad0ed4bf167230aef5dd624fe7865d36055588508f3a139e63 |
