kibatic.prometheus
kibatic.prometheus für Ansible Galaxy
Zusammenfassung
Rollenname in Ansible Galaxy: kibatic.prometheus
Diese Ansible-Rolle hat folgende Funktionen für Prometheus:
- Installation spezifischer Versionen von Prometheus-Server, Node Exporter, Alertmanager.
- Handler für Neustart, Neuladen und Stopp-Ereignisse;
- Grundkonfiguration (echte Konfiguration sollte in den Template-Dateien des Benutzers festgelegt werden; siehe Abschnitt Verwendung unten).
Um diese Rolle einfach zu halten, installiert sie nur 3 Komponenten: Prometheus-Server, Node Exporter und Alertmanager. Verwenden Sie die folgenden Rollen, wenn Sie andere Prometheus-Exporter installieren möchten:
- Consul: William-Yeh.consul_exporter
- Elasticsearch: William-Yeh.es_cluster_exporter
- MongoDB: williamyeh.mongodb_exporter
Rollenvariablen
Obligatorische Variablen
Die zu installierenden Komponenten:
# Unterstützte Komponenten:
#
# [Server-Komponenten]
# - "prometheus"
# - "alertmanager"
#
# [Exporter-Komponenten]
# - "node_exporter"
#
prometheus_components
Optionale Variablen: allgemeine Einstellungen
Benutzerkonfigurierbare Standardwerte:
# Benutzer und Gruppe
prometheus_user: prometheus
prometheus_group: prometheus
# Verzeichnis für ausführbare Dateien
prometheus_install_path: /opt/prometheus
# Verzeichnis für Konfigurationsdateien
prometheus_config_path: /etc/prometheus
# Verzeichnis für Protokolle
prometheus_log_path: /var/log/prometheus
# Verzeichnis für PID-Dateien
prometheus_pid_path: /var/run/prometheus
# Verzeichnis für temporäre Dateien
prometheus_download_path: /tmp
# Version des Hilfsprogramms "gosu"
gosu_version: "1.10"
Optionale Variablen: systemd oder nicht
Wenn die Linux-Distributionen mit systemd ausgestattet sind, wird diese Rolle dieses Mechanismus entsprechend nutzen. Sie können dies deaktivieren (d.h., das traditionelle SysV-Style-Init-Skript verwenden), indem Sie die folgenden Variablen auf false
setzen:
# Derzeit wird nur node_exporter unterstützt.
prometheus_node_exporter_use_systemd
Optionale Variablen: Prometheus-Server
Benutzerkonfigurierbare Standardwerte:
# Welche Version?
prometheus_version: 1.5.0
# Verzeichnis für Regeldateien
prometheus_rule_path: {{ prometheus_config_path }}/rules
# Verzeichnis für file_sd Dateien
prometheus_file_sd_config_path: {{ prometheus_config_path }}/tgroups
# Verzeichnis für die Laufzeitdatenbank
prometheus_db_path: /var/lib/prometheus
Benutzerinstallierbare Konfigurationsdatei (siehe Dokumentation für Details):
# Hauptkonfigurationstemplate relativ zu `playbook_dir`;
# wird installiert in "{{ prometheus_config_path }}/prometheus.yml"
prometheus_conf_main
Benutzerinstallierbare Regeldateien (siehe Dokumentation für Details):
# Regeldateien, die im Verzeichnis "{{ prometheus_rule_path }}" installiert werden;
# Feldinhalte:
# - key: Notiz für diese Regel
# - value:
# - src: Datei relativ zu `playbook_dir`
# - dest: Ziel-Datei relativ zu `{{ prometheus_rule_path }}`
prometheus_rule_files
Alertmanager, der ausgelöst werden soll:
prometheus_alertmanager_url
Zusätzliche Befehlszeilenargumente, falls vorhanden (verwenden Sie prometheus --help
, um die vollständige Liste der Argumente zu sehen):
prometheus_opts
Optionale Variablen: Node Exporter
Benutzerkonfigurierbare Standardwerte:
# Welche Version?
prometheus_node_exporter_version: 0.13.0
Zusätzliche Befehlszeilenargumente, falls vorhanden (verwenden Sie node_exporter --help
, um die vollständige Liste der Argumente zu sehen):
prometheus_node_exporter_opts
Optionale Variablen: Alertmanager
Benutzerkonfigurierbare Standardwerte:
# Welche Version?
prometheus_alertmanager_version: 0.5.1
# Verzeichnis für die Laufzeitdatenbank (derzeit für `silences.json`)
prometheus_alertmanager_db_path: /var/lib/alertmanager
Benutzerinstallierbare Alertmanager-Konfigurationsdatei (siehe Dokumentation für Details):
# Hauptkonfigurationstemplate relativ zu `playbook_dir`;
# wird installiert in "{{ prometheus_config_path }}/alertmanager.yml"
prometheus_alertmanager_conf
Zusätzliche Befehlszeilenargumente, falls vorhanden (verwenden Sie alertmanager --help
, um die vollständige Liste der Argumente zu sehen):
prometheus_alertmanager_opts
Optional: Build aus Quellbaum
(Credit: Robbie Trencheny)
Für die zuvor genannten prometheus_components
können Sie optional aus dem master Branch der Prometheus-Repositories herunterladen/kompilieren, indem Sie die jeweilige Version auf git
setzen.
Es wird ein temporärer Golang-Compiler im Verzeichnis prometheus_workdir
installiert (definiert in defaults/main.yml
).
Wenn Sie beispielsweise den neuesten Code für alle Komponenten erhalten möchten, setzen Sie alle *_version
Variablen auf git
:
prometheus_version: git
prometheus_node_exporter_version: git
prometheus_alertmanager_version: git
Wenn Sie möchten, dass jede Installation erzwungen wird, aktivieren Sie die folgende Variable (Standard ist false
):
prometheus_rebuild: true
Handler
Prometheus-Server:
restart prometheus
reload prometheus
stop prometheus
Node Exporter:
restart node_exporter
reload node_exporter
(tatsächlich dasselbe wierestart
)stop node_exporter
Alertmanager:
restart alertmanager
reload alertmanager
stop alertmanager
Verwendung
Schritt 1: Rolle hinzufügen
Fügen Sie den Rollennamen kibatic.prometheus
zu Ihrer Playbook-Datei hinzu.
Schritt 2: Variablen hinzufügen
Setzen Sie Variablen in Ihrer Playbook-Datei, wenn nötig.
Ein einfaches Beispiel:
---
# Datei: simple-playbook.yml
- hosts: all
become: True
roles:
- kibatic.prometheus
vars:
prometheus_components: [ "prometheus", "alertmanager" ]
prometheus_alertmanager_url: "http://localhost:9093/"
Schritt 3: Benutzerkonfigurationsdateien kopieren, falls nötig
Ein praktisches Beispiel:
---
# Datei: complex-playbook.yml
- hosts: all
become: True
roles:
- kibatic.prometheus
vars:
prometheus_components:
- prometheus
- node_exporter
- alertmanager
prometheus_rule_files:
this_is_rule_1_InstanceDown:
src: some/path/basic.rules
dest: basic.rules
prometheus_alertmanager_conf: some/path/alertmanager.yml.j2
Schritt 4: Durchsuchen der Standard-Prometheus-Seiten
Öffnen Sie die Seite in Ihrem Browser:
- Prometheus -
http://HOST:9090
oderhttp://HOST:9090/consoles/node.html
- Alertmanager -
http://HOST:9093
Abhängigkeiten
Keine.
Mitwirkende
- William Yeh
- Robbie Trencheny - beitrugen zur frühen Version des Kompilierens von Binaries aus Quellcode.
- Travis Truman - beitrugen zur frühen Version des consul_exporter Installers; jetzt verschoben zu William-Yeh.consul_exporter.
- Musee Ullah
Lizenz
MIT Lizenz. Siehe die LICENSE-Datei für Einzelheiten.
ansible-galaxy install kibatic.prometheus