🥇Prometheus: monitorowanie HTTP przez eksporter Blackbox

Cześć wszystkim. W maju OTUS rozpoczyna praktyki z zakresu monitorowania i logowania, zarówno infrastruktury, jak i aplikacji, z użyciem Zabbix, Prometheus, Grafana i ELK. W związku z tym tradycyjnie dzielimy się przydatnymi materiałami na ten temat.

Eksporter Blackbox dla Prometheus umożliwia monitorowanie zewnętrznych usług za pośrednictwem HTTP, HTTPS, DNS, TCP, ICMP. W tym artykule pokażę, jak skonfigurować monitorowanie HTTP/HTTPS za pomocą eksportera Blackbox. Uruchomimy eksporter Blackbox w Kubernetes.

Środowisko

Będziemy potrzebować następujących elementów:

Kubernetes
Operator Prometheus

Konfiguracja eksportera blackbox

Konfigurujemy Blackbox za pomocą ConfigMap dla konfiguracji http modułu monitorowania usług internetowych.

apiVersion: v1
kind: ConfigMap
metadata:
  name: prometheus-blackbox-exporter
  labels:
    app: prometheus-blackbox-exporter
data:
  blackbox.yaml: |
    modules:
      http_2xx:
        http:
          no_follow_redirects: false
          preferred_ip_protocol: ip4
          valid_http_versions:
          - HTTP/1.1
          - HTTP/2
          valid_status_codes: []
        prober: http
        timeout: 5s

Moduł http_2xx jest używany do sprawdzania, czy usługa internetowa zwraca kod statusu HTTP 2xx. Szczegóły dotyczące konfiguracji eksportera blackbox opisano w dokumentacji.

Wdrożenie eksportera blackbox w klastrze Kubernetes

Opisz Deployment i Service do wdrożenia w Kubernetes.

---
kind: Service
apiVersion: v1
metadata:
  name: prometheus-blackbox-exporter
  labels:
    app: prometheus-blackbox-exporter
spec:
  type: ClusterIP
  ports:
    - name: http
      port: 9115
      protocol: TCP
  selector:
    app: prometheus-blackbox-exporter

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: prometheus-blackbox-exporter
  labels:
    app: prometheus-blackbox-exporter
spec:
  replicas: 1
  selector:
    matchLabels:
      app: prometheus-blackbox-exporter
  template:
    metadata:
      labels:
        app: prometheus-blackbox-exporter
    spec:
      restartPolicy: Always
      containers:
        - name: blackbox-exporter
          image: "prom/blackbox-exporter:v0.15.1"
          imagePullPolicy: IfNotPresent
          securityContext:
            readOnlyRootFilesystem: true
            runAsNonRoot: true
            runAsUser: 1000
          args:
            - "--config.file=/config/blackbox.yaml"
          resources:
            {}
          ports:
            - containerPort: 9115
              name: http
          livenessProbe:
            httpGet:
              path: /health
              port: http
          readinessProbe:
            httpGet:
              path: /health
              port: http
          volumeMounts:
            - mountPath: /config
              name: config
        - name: configmap-reload
          image: "jimmidyson/configmap-reload:v0.2.2"
          imagePullPolicy: "IfNotPresent"
          securityContext:
            runAsNonRoot: true
            runAsUser: 65534
          args:
            - --volume-dir=/etc/config
            - --webhook-url=http://localhost:9115/-/reload
          resources:
            {}
          volumeMounts:
            - mountPath: /etc/config
              name: config
              readOnly: true
      volumes:
        - name: config
          configMap:
            name: prometheus-blackbox-exporter

Eksporter Blackbox można wdrożyć za pomocą następującej komendy. Przestrzeń nazw monitoring dotyczy operatora Prometheus.

kubectl --namespace=monitoring apply -f blackbox-exporter.yaml

Upewnij się, że wszystkie usługi są uruchomione, używając następującej komendy:

kubectl --namespace=monitoring get all --selector=app=prometheus-blackbox-exporter

Sprawdzenie Blackbox

Możesz uzyskać dostęp do interfejsu webowego eksportera Blackbox za pomocą port-forward:

kubectl --namespace=monitoring port-forward svc/prometheus-blackbox-exporter 9115:9115

Połącz się z interfejsem webowym eksportera Blackbox za pomocą przeglądarki internetowej pod adresem localhost:9115.

Jeśli przejdziesz pod ten adres http://localhost:9115/probe?module=http_2xx&target=https://www.google.com, zobaczysz wynik sprawdzenia podanego URL (https://www.google.com).

Wartość metryki probe_success równa 1 oznacza pomyślną kontrolę. Wartość 0 oznacza błąd.

Konfiguracja Prometheusa

Po wdrożeniu eksportera BlackBox, konfigurujemy Prometheusa w prometheus-additional.yaml.

- job_name: 'kube-api-blackbox'
  scrape_interval: 1w
  metrics_path: /probe
  params:
    module: [http_2xx]
  static_configs:
   - targets:
      - https://www.google.com
      - http://www.example.com
      - https://prometheus.io
  relabel_configs:
   - source_labels: [__address__]
     target_label: __param_target
   - source_labels: [__param_target]
     target_label: instance
   - target_label: __address__
     replacement: prometheus-blackbox-exporter:9115 # Eksporter blackbox.

Generujemy Secret, używając następującej komendy.

PROMETHEUS_ADD_CONFIG=$(cat prometheus-additional.yaml | base64)
cat << EOF | kubectl --namespace=monitoring apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: additional-scrape-configs
type: Opaque
data:
  prometheus-additional.yaml: $PROMETHEUS_ADD_CONFIG
EOF

Ustawiamy additional-scrape-configs dla Prometheus Operator, używając additionalScrapeConfigs.

kubectl --namespace=monitoring edit prometheuses k8s
...
spec:
  additionalScrapeConfigs:
    key: prometheus-additional.yaml
    name: additional-scrape-configs

Wchodzimy w interfejs webowy Prometheusa, sprawdzamy metryki i cele.

kubectl --namespace=monitoring port-forward svc/prometheus-k8s 9090:9090

Widzę metryki i cele Blackbox.

Dodawanie reguł dla powiadomień (alert)

Aby otrzymywać powiadomienia od eksportera Blackbox, dodamy reguły w Prometheus Operator.

kubectl --namespace=monitoring edit prometheusrules prometheus-k8s-rules
...
  - name: blackbox-exporter
    rules:
    - alert: ProbeFailed
      expr: probe_success == 0
      for: 5m
      labels:
        severity: error
      annotations:
        summary: "Probe failed (instance {{ $labels.instance }})"
        description: "Probe failedn  VALUE = {{ $value }}n  LABELS: {{ $labels }}"
    - alert: SlowProbe
      expr: avg_over_time(probe_duration_seconds[1m]) > 1
      for: 5m
      labels:
        severity: warning
      annotations:
        summary: "Slow probe (instance {{ $labels.instance }})"
        description: "Blackbox probe took more than 1s to completen  VALUE = {{ $value }}n  LABELS: {{ $labels }}"
    - alert: HttpStatusCode
      expr: probe_http_status_code = 400
      for: 5m
      labels:
        severity: error
      annotations:
        summary: "HTTP Status Code (instance {{ $labels.instance }})"
        description: "HTTP status code is not 200-399n  VALUE = {{ $value }}n  LABELS: {{ $labels }}"
    - alert: SslCertificateWillExpireSoon
      expr: probe_ssl_earliest_cert_expiry - time() < 86400 * 30
      for: 5m
      labels:
        severity: warning
      annotations:
        summary: "SSL certificate will expire soon (instance {{ $labels.instance }})"
        description: "SSL certificate expires in 30 daysn  VALUE = {{ $value }}n  LABELS: {{ $labels }}"
    - alert: SslCertificateHasExpired
      expr: probe_ssl_earliest_cert_expiry - time()   1
      for: 5m
      labels:
        severity: warning
      annotations:
        summary: "HTTP slow requests (instance {{ $labels.instance }})"
        description: "HTTP request took more than 1sn  VALUE = {{ $value }}n  LABELS: {{ $labels }}"
    - alert: SlowPing
      expr: avg_over_time(probe_icmp_duration_seconds[1m]) > 1
      for: 5m
      labels:
        severity: warning
      annotations:
        summary: "Slow ping (instance {{ $labels.instance }})"
        description: "Blackbox ping took more than 1sn  VALUE = {{ $value }}n  LABELS: {{ $labels }}"

W interfejsie webowym Prometheus przejdź do sekcji Status => Rules i znajdź reguły powiadomień dla blackbox-exporter.

Konfiguracja powiadomień o wygaśnięciu certyfikatów SSL serwera API Kubernetes.

Skonfigurujmy monitorowanie wygaśnięcia certyfikatów SSL serwera API Kubernetes. Będzie wysyłać powiadomienia raz w tygodniu.

Dodajemy moduł Blackbox eksportera do uwierzytelniania serwera API Kubernetes.

kubectl --namespace=monitoring edit configmap prometheus-blackbox-exporter
...
      kube-api:
        http:
          method: GET
          no_follow_redirects: false
          preferred_ip_protocol: ip4
          tls_config:
            insecure_skip_verify: false
            ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
          bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
          valid_http_versions:
          - HTTP/1.1
          - HTTP/2
          valid_status_codes: []
        prober: http
        timeout: 5s

Dodajemy konfigurację zbierania danych Prometheus

- job_name: 'kube-api-blackbox'
  metrics_path: /probe
  params:
    module: [kube-api]
  static_configs:
   - targets:
      - https://kubernetes.default.svc/api
  relabel_configs:
   - source_labels: [__address__]
     target_label: __param_target
   - source_labels: [__param_target]
     target_label: instance
   - target_label: __address__
     replacement: prometheus-blackbox-exporter:9115 # Eksporter blackbox.

Zastosowanie tajemnicy Prometheusa

PROMETHEUS_ADD_CONFIG=$(cat prometheus-additional.yaml | base64)
cat << EOF | kubectl --namespace=monitoring apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: additional-scrape-configs
type: Opaque
data:
  prometheus-additional.yaml: $PROMETHEUS_ADD_CONFIG
EOF

Dodawanie reguł powiadomień

kubectl --namespace=monitoring edit prometheusrules prometheus-k8s-rules
...
  - name: k8s-api-server-cert-expiry
    rules:
    - alert: K8sAPIServerSSLCertExpiringAfterThreeMonths
      expr: probe_ssl_earliest_cert_expiry{job="kube-api-blackbox"} - time() < 86400 * 90 
      for: 1w
      labels:
        severity: warning
      annotations:
        summary: "Certyfikat SSL serwera API Kubernetes wygaśnie za trzy miesiące (instancja {{ $labels.instance }})"
        description: "Certyfikat SSL serwera API Kubernetes wygasa za 90 dnin  WARTOŚĆ = {{ $value }}n  ETYKIETY: {{ $labels }}"