Apache Flink

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 Apache Flink. En este documento, también se muestra cómo hacer lo siguiente:

  • Configurar Flink para informar 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 colección autoimplementada, consulta la documentación de Flink para 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 información sobre Apache Flink, consulta Apache Flink.

Requisitos

Para recopilar métricas del exportador de Flink 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 Flink, debes usar la versión 1.17 de flink o una posterior.

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

Flink expone las métricas con formato Prometheus cuando se configura con metrics.reporter.prom.factory.class: org.apache.flink.metrics.prometheus.PrometheusReporterFactory.

Si implementaste Flink con los manifiestos de introducción oficiales, agrega esta nueva opción a ConfigMap:

  apiVersion: v1
  kind: ConfigMap
  metadata:
    name: flink-config
    labels:
      app: flink
  data:
    flink-conf.yaml: |+
      ...
  +   metrics.reporter.prom.factory.class: org.apache.flink.metrics.prometheus.PrometheusReporterFactory
  

Si implementaste Flink con el operador oficial, agrega esta opción nueva al campo spec.flinkConfiguration de FlinkDeployment:

  apiVersion: flink.apache.org/v1beta1
  kind: FlinkDeployment
  metadata:
    name: basic-example
  spec:
    image: flink:1.17
    flinkVersion: v1_17
    flinkConfiguration:
      taskmanager.numberOfTaskSlots: "2"
  +   metrics.reporter.prom.factory.class: org.apache.flink.metrics.prometheus.PrometheusReporterFactory
  

Como alternativa, puedes especificar el generador de informes de Prometheus como una opción predeterminada en la configuración del operador de Flink.

Para verificar que el exportador de Flink emita las métricas en los extremos que se espera, haz lo siguiente:

  1. Usa el siguiente comando para configurar la redirección de puertos:

    kubectl -n NAMESPACE_NAME port-forward POD_NAME 9249
    
  2. Accede al extremo localhost:9249/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 exportador de Flink en el mismo espacio de nombres.

Puedes usar la siguiente configuración de PodMonitoring:

# Copyright 2024 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
#
#     http://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: flink
  labels:
    app.kubernetes.io/name: flink
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 9249
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: flink
Asegúrate de que los valores de los campos port y matchLabels coincidan con los de los Pods de Flink que quieres supervisar. Flink expone las métricas en el puerto 9249 de forma predeterminada cuando están habilitadas.

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 las alertas en las métricas de Flink:

# Copyright 2024 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
#
#     http://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: flink-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: flink-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: flink
    interval: 30s
    rules:
    - alert: FlinkHighJVMMemoryNonHeapUsage
      annotations:
        description: |-
          Flink high jvm memory non-heap usage
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Flink high jvm memory non-heap usage (instance {{ $labels.instance }})
      expr: (flink_jobmanager_Status_JVM_Memory_NonHeap_Used/flink_jobmanager_Status_JVM_Memory_NonHeap_Max) >= 0.9
      for: 5m
      labels:
        severity: critical
    - alert: FlinkHighJVMMemoryHeapUsage
      annotations:
        description: |-
          Flink high jvm memory heap usage
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Flink high jvm memory heap usage (instance {{ $labels.instance }})
      expr: (flink_jobmanager_Status_JVM_Memory_Heap_Used/flink_jobmanager_Status_JVM_Memory_Heap_Max) >= 0.9
      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.

Puedes ajustar los umbrales de las alertas para que se adapten a la aplicación.

Verifica la configuración

Puedes usar el Explorador de métricas para verificar si configuraste de forma correcta el exportador de Flink. 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="flink", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualiza paneles

La integración de Cloud Monitoring incluye paneles de “Prometheus”. 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 que quieras ver.

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. Ubica la integración de Apache Flink 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.