Prometheus Proxmox VE Exporter

This is an exporter that exposes information gathered from Proxmox VE node for use by the Prometheus monitoring system.

Installation

pip install prometheus-pve-exporter

Usage

::

usage: pve_exporter [-h] [config] [port]

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

default:
    user: prometheus@pve
    password: sEcr3T!
    verify_ssl: false

The configuration is passed directly into proxmoxer.ProxmoxAPI().

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.

Metadata

Release files for prometheus-pve-exporter 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prometheus-pve-exporter 1.1.0
File	Size	Uploaded
prometheus-pve-exporter-1.1.0.tar.gz	6.4 kB	Jan 22, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for prometheus-pve-exporter 1.1.0
File	Interpreter	ABI	Platform	Reset
prometheus_pve_exporter-1.1.0-py2.py3-none-any.whl 9.2 kB Jan 22, 2018	Python 3, Python 2	none	any	Details

Total release size: 15.6 kB

Release files / prometheus-pve-exporter-1.1.0.tar.gz

Download URL	prometheus-pve-exporter-1.1.0.tar.gz
Size	6.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`e5e8d3ea1b66bc634881fbf7cc3f61b12a64f18bda6c7293f3dea333ad25a087`
BLAKE2b-256 checksum How to use checksums	`07d19c3c10d4cbe5b2977bb5201885e176c0093f37afdcb0c0d21ea28253556c`
Upload date	Jan 22, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / prometheus_pve_exporter-1.1.0-py2.py3-none-any.whl

Download URL	prometheus_pve_exporter-1.1.0-py2.py3-none-any.whl
Size	9.2 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`2c167e6011b22be1ba342352045357f45735f9b3e6e35295770575e0d9e5df2f`
BLAKE2b-256 checksum How to use checksums	`7dfbb4af625546d8f7a517d19cc43801601b703cecbf67f25daa89db8842fa84`
Upload date	Jan 22, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No