17 Konfiguration

17.1 Prometheus Konfigurationsdatei

Die Prometheus-Konfigurationsdatei (prometheus.yml) ist das Herzstück der Prometheus-Konfiguration. Sie definiert, wie Prometheus Metriken sammelt, speichert und verarbeitet. Hier ist eine detaillierte Anleitung zur Erstellung und Anpassung der prometheus.yml.

17.1.1 Struktur der Konfigurationsdatei

Die prometheus.yml besteht aus mehreren Abschnitten, die verschiedene Aspekte der Konfiguration abdecken:

Global:

Definiert globale Einstellungen, die für alle Scrape-Jobs und Regeln gelten.

Beispiel:

global:
  scrape_interval: 15s    # Wie oft Metriken gesammelt werden
  evaluation_interval: 15s # Wie oft Regeln ausgewertet werden

Scrape Configs:
- Definiert, welche Endpunkte (Targets) Prometheus abfragt und wie diese Abfragen durchgeführt werden.
- Beispiel:
```
scrape_configs:
  - job_name: 'prometheus'
    static_configs:
      - targets: ['localhost:9090']
```
Rule Files:
- Listet die Dateien auf, die Alarm- und Aufzeichnungsregeln enthalten.
- Beispiel:
```
rule_files:
  - "alert.rules"
  - "recording.rules"
```

Alerting:

Definiert, wie Alarme verarbeitet und an den Alertmanager gesendet werden.

Beispiel:

alerting:
  alertmanagers:
    - static_configs:
        - targets: ['localhost:9093']

17.1.2 Detaillierte Konfigurationsbeispiele

Globaler Abschnitt:

Der globale Abschnitt enthält Einstellungen, die auf alle Scrape-Jobs und Regeln angewendet werden.

Beispiel:

global:
  scrape_interval: 15s    # Standard-Scraping-Intervall
  evaluation_interval: 15s # Intervall für die Auswertung von Regeln
  external_labels:
    monitor: 'my-monitor'  # Labels, die allen gesammelten Metriken hinzugefügt werden

Scrape Configs:

Scrape-Konfigurationen definieren, welche Endpunkte abgefragt werden und wie diese konfiguriert sind.

Beispiel für statische Konfiguration:

scrape_configs:
  - job_name: 'node_exporter'
    static_configs:
      - targets: ['localhost:9100']

Beispiel für dynamische Konfiguration mit Service Discovery:

scrape_configs:
  - job_name: 'kubernetes-pods'
    kubernetes_sd_configs:
      - role: pod
    relabel_configs:
      - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_scrape]
        action: keep
        regex: true
      - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_path]
        action: replace
        target_label: __metrics_path__
        regex: (.+)
      - source_labels: [__address__]
        action: replace
        target_label: __address__
        regex: (.+):\d+
        replacement: $1:8080

Rule Files:

Regeldateien definieren Alarm- und Aufzeichnungsregeln.

Beispiel:

rule_files:
  - "alert.rules"
  - "recording.rules"

Beispiel für eine alert.rules-Datei:

groups:
- name: example
  rules:
  - alert: HighCPUUsage
    expr: node_cpu_seconds_total > 0.9
    for: 5m
    labels:
      severity: critical
    annotations:
      summary: "High CPU usage detected"
      description: "CPU usage has been above 90% for more than 5 minutes."

Alerting:
- Der Abschnitt für die Alarmierung definiert, wie Alarme an den Alertmanager gesendet werden.
- Beispiel:
```
alerting:
  alertmanagers:
    - static_configs:
        - targets: ['localhost:9093']
```

Relabeling:

Relabeling wird verwendet, um Labels zu ändern, bevor Metriken gespeichert oder gescraped werden.

Beispiel:

scrape_configs:
  - job_name: 'web'
    static_configs:
      - targets: ['webserver1:80', 'webserver2:80']
    relabel_configs:
      - source_labels: [__address__]
        target_label: instance
        regex: (.*):\d+
        replacement: $1

17.1.3 Best Practices

Modularität:
- Teilen Sie die Konfiguration in mehrere Dateien auf, um sie übersichtlicher zu gestalten. Verwenden Sie rule_files, um Regeldateien getrennt von der Hauptkonfigurationsdatei zu verwalten.
Dokumentation:
- Kommentieren Sie Ihre Konfigurationsdateien ausführlich, um die Wartung zu erleichtern und anderen Nutzern das Verständnis zu erleichtern.
Testen:
- Testen Sie Änderungen an der Konfiguration in einer Entwicklungsumgebung, bevor Sie sie in die Produktion übernehmen. Verwenden Sie dazu die --config.file-Option, um verschiedene Konfigurationsdateien auszuprobieren.
Versionierung:
- Verwenden Sie Versionskontrollsysteme wie Git, um Änderungen an der Konfiguration nachzuverfolgen und bei Bedarf schnell zurückrollen zu können.
Überwachung der Konfiguration:
- Überwachen Sie die Logs von Prometheus, um sicherzustellen, dass alle Konfigurationsänderungen korrekt angewendet werden und keine Fehler auftreten.

Durch die sorgfältige Erstellung und Verwaltung der prometheus.yml-Konfigurationsdatei können Sie sicherstellen, dass Prometheus effizient und zuverlässig arbeitet, um Ihre Überwachungsanforderungen zu erfüllen.

17.2 Konfigurationsoptionen und -parameter

Die Konfigurationsoptionen und -parameter in Prometheus bieten eine Vielzahl von Einstellungen, um das Verhalten von Prometheus an die spezifischen Anforderungen Ihrer Überwachungsumgebung anzupassen. Hier sind die wichtigsten Optionen und Parameter, die in der prometheus.yml-Datei konfiguriert werden können.

17.2.1 Globaler Abschnitt

scrape_interval:
- Legt das Intervall fest, in dem Metriken von den Targets abgefragt werden.
- Beispiel:
```
global:
  scrape_interval: 15s
```
evaluation_interval:
- Bestimmt, wie oft Regeln ausgewertet werden.
- Beispiel:
```
global:
  evaluation_interval: 15s
```
external_labels:
- Labels, die allen gesammelten Metriken hinzugefügt werden.
- Beispiel:
```
global:
  external_labels:
    region: 'us-east-1'
```

17.2.2 Scrape Configs

job_name:
- Ein eindeutiger Name für den Scrape-Job.
- Beispiel:
```
scrape_configs:
  - job_name: 'prometheus'
```

static_configs:

Statische Konfiguration von Targets.

Beispiel:

scrape_configs:
  - job_name: 'prometheus'
    static_configs:
      - targets: ['localhost:9090']

kubernetes_sd_configs:

Konfiguration für die automatische Erkennung von Kubernetes-Targets.

Beispiel:

scrape_configs:
  - job_name: 'kubernetes-pods'
    kubernetes_sd_configs:
      - role: pod

relabel_configs:

Regeln zum Ändern von Labels, bevor Metriken gespeichert oder gescraped werden.

Beispiel:

scrape_configs:
  - job_name: 'web'
    static_configs:
      - targets: ['webserver1:80', 'webserver2:80']
    relabel_configs:
      - source_labels: [__address__]
        target_label: instance
        regex: (.*):\d+
        replacement: $1

metric_relabel_configs:

Regeln zum Ändern von Labels, nachdem Metriken gesammelt wurden.

Beispiel:

scrape_configs:
  - job_name: 'node_exporter'
    static_configs:
      - targets: ['localhost:9100']
    metric_relabel_configs:
      - source_labels: [__name__]
        regex: 'node_cpu_seconds_total'
        action: drop

honor_labels:

Gibt an, ob Labels von Targets beibehalten oder überschrieben werden sollen.

Beispiel:

scrape_configs:
  - job_name: 'node_exporter'
    static_configs:
      - targets: ['localhost:9100']
    honor_labels: true

17.2.3 Rule Files

rule_files:
- Listet die Dateien auf, die Regeln enthalten.
- Beispiel:
```
rule_files:
  - "alert.rules"
  - "recording.rules"
```

Gruppen und Regeln:

Regeln können in Gruppen organisiert werden, um ähnliche Regeln zusammenzufassen.

Beispiel:

groups:
- name: example
  rules:
  - alert: HighCPUUsage
    expr: node_cpu_seconds_total > 0.9
    for: 5m
    labels:
      severity: critical
    annotations:
      summary: "High CPU usage detected"
      description: "CPU usage has been above 90% for more than 5 minutes."

17.2.4 Alerting

alertmanagers:

Definiert, wie Alarme an den Alertmanager gesendet werden.

Beispiel:

alerting:
  alertmanagers:
    - static_configs:
        - targets: ['localhost:9093']

send_resolved:

Gibt an, ob aufgelöste Alarme gesendet werden sollen.

Beispiel:

alerting:
  alertmanagers:
    - static_configs:
        - targets: ['localhost:9093']
      send_resolved: true

17.2.5 Service Discovery

file_sd_configs:

Ermöglicht die Angabe von Targets über Dateien.

Beispiel:

scrape_configs:
  - job_name: 'file_sd'
    file_sd_configs:
      - files:
        - 'targets.json'

consul_sd_configs:

Konfiguration für die automatische Erkennung von Consul-Targets.

Beispiel:

scrape_configs:
  - job_name: 'consul'
    consul_sd_configs:
      - server: 'localhost:8500'

dns_sd_configs:

Konfiguration für die automatische Erkennung von DNS-Targets.

Beispiel:

scrape_configs:
  - job_name: 'dns'
    dns_sd_configs:
      - names:
        - 'prometheus.example.com'

17.2.6 TLS und Authentifizierung

tls_config:

Konfiguration für TLS-Verbindungen.

Beispiel:

scrape_configs:
  - job_name: 'secure'
    static_configs:
      - targets: ['secure.example.com:443']
    tls_config:
      ca_file: /etc/prometheus/certs/ca.crt
      cert_file: /etc/prometheus/certs/client.crt
      key_file: /etc/prometheus/certs/client.key
      server_name: 'secure.example.com'
      insecure_skip_verify: false

basic_auth:

Konfiguration für Basic-Auth-Authentifizierung.

Beispiel:

scrape_configs:
  - job_name: 'auth'
    static_configs:
      - targets: ['auth.example.com:80']
    basic_auth:
      username: 'user'
      password: 'password'

17.2.7 HTTP-Einstellungen

bearer_token:

Verwendung eines Bearer Tokens für die Authentifizierung.

Beispiel:

scrape_configs:
  - job_name: 'bearer_token'
    static_configs:
      - targets: ['bearer.example.com:80']
    bearer_token: 'your_bearer_token'

proxy_url:

Konfiguration eines Proxy-Servers.

Beispiel:

scrape_configs:
  - job_name: 'proxy'
    static_configs:
      - targets: ['proxy.example.com:80']
    proxy_url: 'http://proxy.example.com:8080'

17.2.8 Weitere Einstellungen

scrape_timeout:

Legt das Timeout für das Scraping von Metriken fest.

Beispiel:

scrape_configs:
  - job_name: 'timeout'
    static_configs:
      - targets: ['timeout.example.com:80']
    scrape_timeout: 10s

scheme:

Bestimmt, ob HTTP oder HTTPS verwendet wird.

Beispiel:

scrape_configs:
  - job_name: 'https'
    static_configs:
      - targets: ['secure.example.com:443']
    scheme: https

Diese Konfigurationsoptionen und -parameter ermöglichen eine flexible und leistungsfähige Anpassung von Prometheus, um den spezifischen Anforderungen Ihrer Überwachungsumgebung gerecht zu werden. Durch das Verständnis und die korrekte Anwendung dieser Einstellungen können Sie die Effizienz und Zuverlässigkeit Ihrer Monitoring-Lösung maximieren.