HAProxy

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere le metriche dal servizio PROMEX per HAProxy. Questo documento illustra come:

• Configura il servizio PROMEX per HAProxy in modo che registri le metriche.
• Configura una risorsa PodMonitoring per Managed Service per Prometheus per raccogliere le metriche esportate.
• Accedi a una dashboard in Cloud Monitoring per visualizzare le metriche.
• Configura le regole di avviso per monitorare le metriche.

Queste istruzioni si applicano solo se utilizzi la raccolta gestita con Managed Service per Prometheus. Se utilizzi la raccolta di cui hai eseguito il deployment autonomo, consulta la documentazione di HAProxy per informazioni sull'installazione.

Queste istruzioni sono fornite come esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se hai difficoltà a installare un'applicazione o un esportatore a causa di criteri di sicurezza o organizzativi restrittivi, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su HAProxy, consulta HAProxy.

Prerequisiti

Per raccogliere le metriche dal servizio PROMEX per HAProxy utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:

• Sul cluster deve essere in esecuzione Google Kubernetes Engine versione 1.21.4-gke.300 o successiva.
• Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta la guida introduttiva alla raccolta gestita.

• Per utilizzare le dashboard disponibili in Cloud Monitoring per l'integrazione di HAProxy, devi utilizzare haproxy_promex versione 2.4 o successive.

  Per ulteriori informazioni sulle dashboard disponibili, consulta Visualizzare le dashboard.

La maggior parte delle immagini Docker ufficiali per le versioni superiori o uguali alla 2.4 viene creata con questo servizio abilitato.

Il seguente esempio di configurazione è stato creato facendo riferimento alla documentazione di HAProxy Enterprise. Funziona con la versione community e può essere modificato in base a esigenze specifiche:

Modifica la configurazione di HAProxy

Modifica la configurazione di HAProxy come mostrato nell'esempio seguente:

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: v1
kind: ConfigMap
metadata:
  name: haproxy
data:
  haproxy.cfg: |
    ...
+   frontend prometheus
+     mode http
+     bind *:8404
+     http-request use-service prometheus-exporter if { path /metrics }
    ...
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: haproxy
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: haproxy
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: haproxy
    spec:
      containers:
      - name: haproxy
        image: haproxy:2.8
        ports:
+       - containerPort: 8404
+         name: prometheus
        volumeMounts:
        - mountPath: /usr/local/etc/haproxy/haproxy.cfg
          subPath: haproxy.cfg
          name: haproxy
      volumes:
      - name: haproxy
        configMap:
          name: haproxy
          items:
          - key: haproxy.cfg
            path: haproxy.cfg

Devi aggiungere eventuali righe precedute dal simbolo + alla configurazione.

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per verificare che il servizio PROMEX per HAProxy stia emettendo metriche sugli endpoint previsti:

1. Configura il port forwarding utilizzando il seguente comando:

   kubectl -n NAMESPACE_NAME port-forward POD_NAME 8404
   

2. Accedi all'endpoint localhost:8404/metrics utilizzando il browser o l'utilità curl in un'altra sessione del terminale.

Definisci una risorsa PodMonitoring

Per il rilevamento dei target, l'operatore Managed Service for Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore HAProxy nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione di PodMonitoring:

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: haproxy
  labels:
    app.kubernetes.io/name: haproxy
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: haproxy

HAProxy espone le metriche dei target definiti nell'opzione di configurazione bind. Questa opzione richiede che un utente definisca l'indirizzo IP e la porta su cui ascoltare le metriche di scraping.

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definire regole e avvisi

Puoi utilizzare la seguente configurazione Rules per definire gli avvisi sulle metriche di HAProxy:

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: haproxy-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: haproxy-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: haproxy
    interval: 30s
    rules:
    - alert: HAProxyDown
      annotations:
        description: |-
          HAProxy instance is down
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: HAProxy down (instance {{ $labels.instance }})
      expr: haproxy_server_up{job="haproxy"} == 0
      for: 5m
      labels:
        severity: critical
    - alert: HAProxyTooManyConnections
      annotations:
        description: |-
          HAProxy instance has too many connections
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: HAProxy too many connections (instance {{ $labels.instance }})
      expr: haproxy_frontend_current_sessions{job="haproxy"} / haproxy_frontend_limit_sessions{job="haproxy"} * 100 > 90
      for: 5m
      labels:
        severity: warning

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per ulteriori informazioni sull'applicazione delle regole al cluster, consulta Valutazione e generazione di avvisi delle regole gestite.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore HAProxy. Potrebbero essere necessari uno o due minuti per il caricamento delle metriche da parte di Cloud Monitoring.

Per verificare che le metriche siano importate, procedi nel seguente modo:

1. Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:

   Vai a Esplora metriche

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Nella barra degli strumenti del riquadro Query Builder, seleziona il pulsante code MQL o code PromQL.
3. Verifica che PromQL sia selezionato nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
4. Inserisci ed esegui la seguente query:
   

   up{job="haproxy", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualizza dashboard

L'integrazione di Cloud Monitoring include la dashboard Panoramica di Prometheus di HAProxy. Le dashboard vengono installate automaticamente quando configuri l'integrazione. Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

1. Nella console Google Cloud, vai alla pagina  Dashboard:

   Vai a Dashboard

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Seleziona la scheda Elenco dashboard.
3. Scegli la categoria Integrazioni.
4. Fai clic sul nome della dashboard, ad esempio Panoramica di Prometheus di HAProxy.

Per visualizzare un'anteprima statica della dashboard:

1. Nella console Google Cloud, vai alla pagina  Integrazioni:

   Vai a Integrations (Integrazioni).

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
3. Individua l'integrazione di HAProxy e fai clic su Visualizza dettagli.
4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di importazione delle metriche, consulta Problemi di raccolta dagli esportatori in Risoluzione dei problemi relativi all'importazione.