github
/
prometheus-pve-sd
mirror of https://github.com/thegeeklab/prometheus-pve-sd.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add missing env vars to docs and adjust formatting (#193)

This commit is contained in:
Robert Kaussow 2022-03-30 21:28:17 +02:00 committed by GitHub
parent 9c89d4e922
commit d5d00e849b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/content/configuration/defaults.md
View File

@ -5,9 +5,9 @@ title: Default settings
```Shell ```Shell
--- ---
logging: logging:
# supported log levels: debug|info|warning|error|critical # Supported log levels: debug|info|warning|error|critical
level: warning level: warning
# supported log formats: console|json|simple # Supported log formats: console|json|simple
format: console format: console
metrics: metrics:
@ -24,11 +24,14 @@ loop_delay: 300
service: true service: true
exclude_state: [] exclude_state: []
# needs to be a list of strings
# Needs to be a list of strings.
exclude_vmid: [] exclude_vmid: []
include_vmid: [] include_vmid: []
# can be used to exclude vms by tags (proxmox 6+) # Can be used to exclude vms by tags (proxmox 6+) - needs to be a list of strings.
# If `include_tags` and `exclude_tags` are set at the same time, the `exclude_tags` option takes precedence.
# If `include_tags` is set, and your VM don't have any tags set, they will not show up!
exclude_tags: [] exclude_tags: []
include_tags: [] include_tags: []
@ -47,7 +50,3 @@ pve:
# auth_timeout: 5 # auth_timeout: 5
# verify_ssl: true # verify_ssl: true
``` ```
If `include_tags` and `exclude_tags` are set at the same time, the `exclude_tags` option takes precedence.
If `include_tags` is set, and your VM don't have any tags set, they will not show up!

7
docs/content/configuration/env.md
View File

@ -24,10 +24,15 @@ PROMETHEUS_PVE_SD_LOOP_DELAY=300
PROMETHEUS_PVE_SD_SERVICE=true PROMETHEUS_PVE_SD_SERVICE=true
PROMETHEUS_PVE_SD_EXCLUDE_STATE= PROMETHEUS_PVE_SD_EXCLUDE_STATE=
PROMETHEUS_PVE_SD_EXCLUDE_VMID=
# comma-separated list
PROMETHEUS_PVE_SD_EXCLUDE_VMID=
PROMETHEUS_PVE_SD_INCLUDE_VMID= PROMETHEUS_PVE_SD_INCLUDE_VMID=
# comma-separated list
PROMETHEUS_PVE_SD_EXCLUDE_TAGS=
PROMETHEUS_PVE_SD_INCLUDE_TAGS=
PROMETHEUS_PVE_SD_PVE_SERVER= PROMETHEUS_PVE_SD_PVE_SERVER=
PROMETHEUS_PVE_SD_PVE_USER= PROMETHEUS_PVE_SD_PVE_USER=
PROMETHEUS_PVE_SD_PVE_PASSWORD= PROMETHEUS_PVE_SD_PVE_PASSWORD=

12
prometheuspvesd/config.py
View File

@ -100,18 +100,18 @@ class Config():
"file": True, "file": True,
"type": environs.Env().list "type": environs.Env().list
}, },
"exclude_tags": {
"default": [],
"env": "EXCLUDE_TAGS",
"file": True,
"type": environs.Env().list
},
"include_vmid": { "include_vmid": {
"default": [], "default": [],
"env": "INCLUDE_VMID", "env": "INCLUDE_VMID",
"file": True, "file": True,
"type": environs.Env().list "type": environs.Env().list
}, },
"exclude_tags": {
"default": [],
"env": "EXCLUDE_TAGS",
"file": True,
"type": environs.Env().list
},
"include_tags": { "include_tags": {
"default": [], "default": [],
"env": "INCLUDE_TAGS", "env": "INCLUDE_TAGS",

66
prometheuspvesd/pve.json
View File

@ -1,66 +0,0 @@
[
{
"targets": [
"fhnw-syspr01"
],
"labels": {
"__meta_pve_ipv4": "10.112.153.88",
"__meta_pve_ipv6": null,
"__meta_pve_name": "fhnw-syspr01",
"__meta_pve_type": "qemu",
"__meta_pve_vmid": "103",
"__meta_pve_cpu": "1",
"__meta_pve_cores": "2",
"__meta_pve_memory": "2048",
"__meta_pve_status": "running"
}
},
{
"targets": [
"admin03"
],
"labels": {
"__meta_pve_ipv4": "10.112.153.83",
"__meta_pve_ipv6": null,
"__meta_pve_name": "admin03",
"__meta_pve_type": "qemu",
"__meta_pve_vmid": "102",
"__meta_pve_cpu": "1",
"__meta_pve_cores": "1",
"__meta_pve_memory": "1024",
"__meta_pve_status": "running"
}
},
{
"targets": [
"psql02"
],
"labels": {
"__meta_pve_ipv4": "10.112.153.91",
"__meta_pve_ipv6": null,
"__meta_pve_name": "psql02",
"__meta_pve_type": "qemu",
"__meta_pve_vmid": "100",
"__meta_pve_cpu": "1",
"__meta_pve_cores": "4",
"__meta_pve_memory": "4096",
"__meta_pve_status": "running"
}
},
{
"targets": [
"fhnw-gitlab01"
],
"labels": {
"__meta_pve_ipv4": "10.112.153.92",
"__meta_pve_ipv6": null,
"__meta_pve_name": "fhnw-gitlab01",
"__meta_pve_type": "qemu",
"__meta_pve_vmid": "104",
"__meta_pve_cpu": "1",
"__meta_pve_cores": "2",
"__meta_pve_memory": "2048",
"__meta_pve_status": "running"
}
}
]