HAProxy

En este documento, se describe cómo configurar una implementación de Google Kubernetes Engine con el objetivo de usar Google Cloud Managed Service para Prometheus y recopilar métricas de HAProxy. En este documento, también se muestra cómo hacer lo siguiente:

  • Configurar HAProxy para informar las métricas
  • Configurar un recurso PodMonitoring con el objetivo de que Managed Service para Prometheus recopile las métricas exportadas
  • Acceder a un panel de Cloud Monitoring para ver las métricas
  • Configurar reglas de alerta para supervisar las métricas

Estas instrucciones se aplican solo si usas la recopilación administrada con Managed Service para Prometheus. Si usas la recopilación autoimplementada, consulta la documentación de HAProxy para obtener conocer más sobre la instalación.

Estas instrucciones se proporcionan a modo de ejemplo y se espera que funcionen en la mayoría de los entornos de Kubernetes. Si tienes problemas a la hora de instalar una aplicación o un exportador debido a políticas restrictivas de la organización o de seguridad, te recomendamos que consultes la documentación de código abierto para obtener asistencia.

Para obtener más información, consulta HAProxy.

Requisitos

Para recopilar métricas del servicio PROMEX para HAProxy con Managed Service para Prometheus y la recopilación administrada, la implementación debe cumplir con los siguientes requisitos:

  • El clúster debe ejecutar la versión 1.21.4-gke.300 o posterior de Google Kubernetes Engine.
  • Debes ejecutar Managed Service para Prometheus con la recopilación administrada habilitada. Para obtener más información, consulta Empieza a usar la recopilación administrada.

  • Para usar los paneles disponibles en Cloud Monitoring para la integración de HAProxy, debes usar la versión 2.4 de haproxy_promex o una posterior.

    Para obtener más información sobre los paneles disponibles, consulta Visualiza paneles.

HAProxy expone métricas con formato de Prometheus solo cuando se compila con el servicio habilitado y se incluye un frontend adecuado en la configuración.

La mayoría de las imágenes de Docker oficiales para versiones superiores o iguales a la 2.4 se compilan con este servicio habilitado.

El siguiente ejemplo de configuración se creó con la documentación de HAProxy Enterprise. Funciona con Community Edition y se puede modificar para satisfacer necesidades específicas:

Modifica la configuración de HAProxy

Modifica la configuración de HAProxy como se muestra en el siguiente ejemplo:

# 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

Debes agregar cualquier línea precedida por el símbolo + a la configuración.

Para aplicar cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar los parámetros de configuración.

Para verificar que el servicio PROMEX para HAProxy emite métricas en los extremos esperados, haz lo siguiente:

  1. Usa el siguiente comando para configurar la redirección de puertos: 
    kubectl -n NAMESPACE_NAME port-forward POD_NAME 8404
  2. Accede al extremo localhost:8404/metrics con el navegador o la utilidad curl en otra sesión de terminal.

Define un recurso PodMonitoring

Para el descubrimiento de destinos, el operador de Managed Service para Prometheus requiere un recurso PodMonitoring que corresponda al servicio PROMEX para HAProxy en el mismo espacio de nombres.

Puedes usar la siguiente configuración de 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
Asegúrate de que los valores de los campos port y matchLabels coincidan con los de los Pods de HAProxy que quieras supervisar.

HAProxy expone métricas de los destinos definidos en la opción de configuración bind. Esta opción requiere que un usuario defina la dirección IP y el puerto que se escuchará en la recopilación de métricas.

Para aplicar cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar los parámetros de configuración.

Define reglas y alertas

Puedes usar la siguiente configuración de Rules para definir alertas en las métricas de 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

Para aplicar cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar los parámetros de configuración.

Para obtener más información sobre cómo aplicar reglas al clúster, consulta Evaluación y alertas de reglas administradas.

Verifica la configuración

Puedes usar el Explorador de métricas para verificar si configuraste de forma correcta el servicio PROMEX para HAProxy. Cloud Monitoring puede tardar uno o dos minutos en transferir las métricas.

Para verificar que se hayan transferido las métricas, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página  Explorador de métricas:

    Acceder al Explorador de métricas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre es  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el botón de activación Lenguaje. El botón de activación de lenguaje se encuentra en la misma barra de herramientas que permite dar formato a la consulta.
  4. Ingresa y ejecuta la siguiente consulta:
    up{job="haproxy", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualiza paneles

La integración de Cloud Monitoring incluye el panel HAProxy Prometheus Overview. Los paneles se instalan automáticamente cuando configuras la integración. También puedes obtener vistas previas estáticas de los paneles sin instalar la integración.

Para ver un panel instalado, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página Paneles :

    Acceder a Paneles

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Selecciona la pestaña Lista de paneles.
  3. Elige la categoría Integraciones.
  4. Haz clic en el nombre del panel, por ejemplo, DHAProxy Prometheus Overview.

Para obtener una vista previa estática del panel, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página Integraciones :

    Acceder a Integraciones

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en el filtro de la plataforma de implementación Kubernetes Engine.
  3. Localiza la integración de HAProxy y haz clic en Ver detalles.
  4. Selecciona la pestaña Paneles.

Soluciona problemas

Para obtener información sobre cómo solucionar problemas de transferencia de métricas, consulta Problemas de recopilación de exportadores en Soluciona problemas de transferencia.