Controlador Ingress NGINX

En este documento se describe cómo configurar tu implementación de Google Kubernetes Engine para que puedas usar Google Cloud Managed Service para Prometheus y recoger métricas de Ingress NGINX Controller. En este documento se explica cómo hacer lo siguiente:

  • Configura Ingress NGINX para que genere informes de métricas.
  • Accede a un panel de control de Cloud Monitoring para ver las métricas.
  • Configura reglas de alertas para monitorizar las métricas.

Estas instrucciones solo se aplican si usas la recogida gestionada con Managed Service para Prometheus. Si utiliza la recogida autodesplegada, consulte la documentación de Ingress NGINX para obtener información sobre la instalación.

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

Para obtener información sobre el controlador de entradas NGINX, consulta Entradas NGINX.

Requisitos previos

Para recoger métricas del controlador Ingress NGINX con el servicio gestionado de Prometheus y la recogida gestionada, tu despliegue debe cumplir los siguientes requisitos:

  • Tu clúster debe ejecutar la versión 1.28.15-gke.2475000 de Google Kubernetes Engine o una posterior.
  • Debes ejecutar Managed Service para Prometheus con la recogida gestionada habilitada. Para obtener más información, consulta el artículo Empezar a utilizar la recogida gestionada.

Ingress NGINX expone automáticamente las métricas en formato Prometheus, por lo que no tienes que instalarlo por separado. Para verificar que el controlador Ingress NGINX expone métricas, ejecuta el siguiente comando: 
  kubectl exec -n NAMESPACE_NAME deploy/ingress-nginx-controller -- curl http://localhost:10254/metrics

Definir un recurso de PodMonitoring

Para la detección de destinos, el operador de Managed Service para Prometheus requiere un recurso PodMonitoring que corresponda al controlador Ingress NGINX 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: ingress-nginx
  labels:
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 10254
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: ingress-nginx
Asegúrate de que los valores de los campos port y matchLabels coincidan con los de los pods de Ingress NGINX que quieras monitorizar. De forma predeterminada, el controlador Ingress NGINX expone métricas en el puerto 10254 y tiene la etiqueta app.kubernetes.io/name: ingress-nginx.

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para gestionar tus configuraciones.

Definir reglas y alertas

Puedes usar la siguiente configuración de Rules para definir alertas en tus métricas de Ingress NGINX:

# 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: ingress-nginx-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: ingress-nginx-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: ingress-nginx
    interval: 30s
    rules:
    - alert: NGINXIngressDroppedConnections
      annotations:
        description: |-
          NGINX Ingress dropped connections
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress dropped connections (instance {{ $labels.instance }})
      expr: (nginx_ingress_controller_nginx_process_connections_total{state="accepted"} - nginx_ingress_controller_nginx_process_connections_total{state="handled"}) > 0
      for: 5m
      labels:
        severity: critical
    - alert: NGINXIngressHighRequestRate
      annotations:
        description: |-
          NGINX Ingress high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress high request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: NGINXIngressLowRequestRate
      annotations:
        description: |-
          NGINX Ingress low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress low request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) < 10
      for: 5m
      labels:
        severity: warning

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para gestionar tus configuraciones.

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

Puedes ajustar los umbrales de alerta para que se adapten a tu aplicación.

Verificar la configuración

Puede usar el Explorador de métricas para verificar que ha configurado correctamente el controlador Ingress NGINX. Cloud Monitoring puede tardar uno o dos minutos en ingerir tus métricas.

Para comprobar que las métricas se han insertado, haz lo siguiente:

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

    Ve al explorador de métricas.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas del panel de creación de consultas, selecciona el botón cuyo nombre sea  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el interruptor Idioma. El interruptor de idioma se encuentra en la misma barra de herramientas que te permite dar formato a tu consulta.
  4. Introduce y ejecuta la siguiente consulta:
    up{job="ingress-nginx", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Ver paneles de control

La integración de Cloud Monitoring incluye el panel de control Resumen de Prometheus de Ingress NGINX. Los paneles de control se instalan automáticamente al configurar la integración. También puedes ver vistas previas estáticas de los paneles de control sin instalar la integración.

Para ver un panel de control instalado, siga estos pasos:

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

    Ve a Paneles.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. Seleccione la pestaña Lista de paneles.
  3. Elige la categoría Integraciones.
  4. Haga clic en el nombre del panel de control (por ejemplo, Ingress NGINX Prometheus Overview).

Para ver una vista previa estática del panel de control, siga estos pasos:

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

    Ve a Integraciones.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. Haz clic en el filtro de plataforma de implementación Kubernetes Engine.
  3. Busca la integración de Ingress NGINX Controller y haz clic en Ver detalles.
  4. Seleccione la pestaña Paneles.

Solución de problemas

Para obtener información sobre cómo solucionar problemas de ingestión de métricas, consulta la sección Problemas con la recogida de datos de los exportadores del artículo Solucionar problemas del lado de la ingestión.