ansible-collection-prometheus/roles/systemd_exporter/meta/argument_specs.yml
gardar 5e220e5f40
refactor(systemd_exporter): delegate common tasks to _common role
Signed-off-by: gardar <gardar@users.noreply.github.com>
2024-10-15 17:15:24 +00:00

66 lines
3.5 KiB
YAML

---
# yamllint disable rule:line-length
argument_specs:
main:
short_description: "Prometheus Systemd Exporter"
description:
- "Deploy prometheus L(systemd exporter,https://github.com/prometheus-community/systemd_exporter) using ansible."
author:
- "Prometheus Community"
options:
systemd_exporter_version:
description: "SystemD exporter package version. Also accepts latest as parameter."
default: "0.6.0"
systemd_exporter_binary_url:
description: URL of the systemd exporter binaries .tar.gz file"
default: "https://github.com/{{ _systemd_exporter_repo }}/releases/download/v{{ systemd_exporter_version }}/systemd_exporter-{{ systemd_exporter_version }}.{{ ansible_system | lower }}-{{ _systemd_exporter_go_ansible_arch }}.tar.gz"
systemd_exporter_checksums_url:
description: "URL of the systemd exporter checksums file"
default: "https://github.com/{{ _systemd_exporter_repo }}/releases/download/v{{ systemd_exporter_version }}/sha256sums.txt"
systemd_exporter_web_listen_address:
description: Address on which systemd exporter will listen"
default: "0.0.0.0:9558"
systemd_exporter_tls_server_config:
description:
- "Configuration for TLS authentication."
- "Keys and values are the same as in L(Prometheus docs,https://prometheus.io/docs/prometheus/latest/configuration/https/)."
type: "dict"
systemd_exporter_enable_restart_count:
description: Enables service restart count metrics. This feature only works with systemd 235 and above"
type: "bool"
default: false
systemd_exporter_enable_ip_accounting:
description: Enables service ip accounting metrics. This feature only works with systemd 235 and above"
type: "bool"
default: false
systemd_exporter_enable_file_descriptor_size:
description: Enables file descriptor size metrics. This feature will cause exporter to run as root as it needs access to /proc/X/fd"
type: "bool"
default: false
systemd_exporter_unit_include:
description: "Include some systemd units. Expects a regex. More in L(systemd_exporter docs,https://github.com/prometheus-community/systemd_exporter#configuration)."
systemd_exporter_unit_exclude:
description: "Exclude some systemd units. Expects a regex. More in L(systemd_exporter docs,https://github.com/prometheus-community/systemd_exporter#configuration)."
systemd_exporter_binary_install_dir:
description:
- "I(Advanced)"
- "Directory to install systemd_exporter binary"
default: "/usr/local/bin"
systemd_exporter_system_group:
description:
- "I(Advanced)"
- "System group for systemd exporter"
default: "systemd-exporter"
systemd_exporter_system_user:
description:
- "I(Advanced)"
- "Systemd exporter user"
default: "systemd-exporter"
systemd_exporter_log_level:
description: Only log messages with the given severity or above.
systemd_exporter_local_cache_path:
description: "Local path to stash the archive and its extraction"
default: "/tmp/systemd_exporter-{{ ansible_system | lower }}-{{ _systemd_exporter_go_ansible_arch }}/{{ systemd_exporter_version }}"
systemd_exporter_config_dir:
description: "Path to directory with systemd_exporter configuration"
default: "/etc/systemd_exporter"