prometheus-pve-sd/docs/content/usage/_index.md
Mathias Petermann d15a01fd6a
fix: add proper discovery of IPv6 and IPv4 addresses (#155)
BREAKING CHANGE: The label `__meta_pve_ip` was removed in favor of `__meta_pve_ipv4` and `__meta_pve_ipv6`.
2022-02-27 12:31:46 +01:00

1.2 KiB

title
Usage

{{< toc >}}

Start PVE SD

Create a configuration file with the required parameters to connect to your PVE server before you start the service.

run prometheus-pve-sd -vv --loop-delay 900 -o /etc/prometheus/pve.json

Available Labels

The following list of meta labels can be used to relabel your scrape results:

__meta_pve_ipv4

__meta_pve_ipv6

__meta_pve_name

__meta_pve_type

__meta_pve_vmid

__meta_pve_cpu

__meta_pve_cores

__meta_pve_memory

__meta_pve_status

__meta_pve_groups
Groups will be discovered from the Notes field of a host and need to be set as JSON e.g. {"groups":["group1","group2"]}

Prometheus configuration

This example configuration snippet for the Prometheus scrape_config Prometheus to scrape telegraf assuming that it is deployed on all your servers.

- file_sd_configs:
  - files:
    - /opt/prometheus/conf/file_sd/proxmox.json
  job_name: telegraf-pve
  metrics_path: /metrics
  relabel_configs:
  - replacement: telegraf
    target_label: job
  - replacement: ${1}:9273
    source_labels:
    - __meta_pve_name
    target_label: __address__
  - source_labels:
    - __meta_pve_name
    target_label: instance