prometheus-pve-exporter

Proxmox VE exporter for the Prometheus monitoring system.

These details have not been verified by PyPI

Project links

Homepage

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

Using pip:

pip install prometheus-pve-exporter

Using docker:

docker pull prompve/prometheus-pve-exporter

Example: Display usage message:

docker run -it --rm prompve/prometheus-pve-exporter --help

Example: 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-exporter

Prometheus 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

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.

Grafana Dashboards

Proxmox via Prometheus by Pietro Saccardi

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

3.4.5

Sep 16, 2024

3.4.4

Aug 15, 2024

3.4.3

Jul 3, 2024

3.4.2

May 26, 2024

3.4.1

May 6, 2024

3.4.0

Apr 30, 2024

3.3.0

Apr 27, 2024

3.2.5

Apr 17, 2024

3.2.4

Apr 12, 2024

3.2.2

Feb 6, 2024

3.2.1

Jan 7, 2024

3.1.0

Jan 3, 2024

3.0.2

Nov 5, 2023

3.0.0b1 pre-release

Oct 16, 2023

2.3.1

Aug 2, 2023

2.3.0

Apr 26, 2023

2.2.4

Oct 16, 2022

2.2.3

Mar 6, 2022

2.2.2

Sep 16, 2021

2.2.1

Sep 16, 2021

2.2.0

Aug 27, 2021

2.1.2

Apr 4, 2021

2.1.1

Mar 5, 2021

2.1.0

Feb 19, 2021

2.0.3

Dec 17, 2020

2.0.1

Oct 22, 2020

2.0.0

Oct 19, 2020

1.3.2

Jul 2, 2020

This version

1.3.1

Jul 2, 2020

1.3.0

Jul 2, 2020

1.2.2

May 18, 2020

1.2.1

May 3, 2020

1.2.0

Apr 20, 2020

1.1.2

Oct 17, 2018

1.1.1

Feb 28, 2018

1.1.0

Jan 22, 2018

1.0.0

Nov 1, 2017

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prometheus-pve-exporter-1.3.1.tar.gz (7.3 kB view details)

Uploaded Jul 2, 2020 Source

Built Distribution

prometheus_pve_exporter-1.3.1-py2.py3-none-any.whl (12.7 kB view details)

Uploaded Jul 2, 2020 Python 2 Python 3

File details

Details for the file prometheus-pve-exporter-1.3.1.tar.gz.

File metadata

Download URL: prometheus-pve-exporter-1.3.1.tar.gz
Upload date: Jul 2, 2020
Size: 7.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for prometheus-pve-exporter-1.3.1.tar.gz
Algorithm	Hash digest
SHA256	`338d1974e86f7b1c076507891cf5d20857c8008cee289dafe5959b2ce8371567`
MD5	`57ac86376c6ddd19a0085e5cf46fac08`
BLAKE2b-256	`3492a41becc318a8d8b48ee822539b81c8ac6c8e0f2f66ea5a3f0c24973f3f93`

See more details on using hashes here.

File details

Details for the file prometheus_pve_exporter-1.3.1-py2.py3-none-any.whl.

File metadata

Download URL: prometheus_pve_exporter-1.3.1-py2.py3-none-any.whl
Upload date: Jul 2, 2020
Size: 12.7 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for prometheus_pve_exporter-1.3.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`346123c95db91a68df92651e565172b6918878ad35c7200a59e09640bbc06380`
MD5	`454b52770531d3a5a8415412354598d3`
BLAKE2b-256	`cd244d7428be28211b9f9cc748c5a20b67261a74f92b2d6f45393a17899c4afb`