Apache Kafka

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 Apache Kafka. En este documento se explica cómo hacer lo siguiente:

• Configura el exportador de Kafka 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 el repositorio de origen del exportador de Kafka 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 Apache Kafka, consulta Kafka.

Requisitos previos

Para recoger métricas de Kafka con Managed Service para 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.

• Para usar los paneles de control disponibles en Cloud Monitoring para la integración de Kafka, debes usar la kafka_exporterversión 1.6.0 o una posterior.

  Para obtener más información sobre los paneles de control disponibles, consulta el artículo Ver paneles de control.

Instalar el exportador de Kafka

Te recomendamos que instales el exportador de Kafka, kafka_exporter, con la siguiente configuración:

# 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: apps/v1
kind: Deployment
metadata:
  name: kafka-exporter
  labels:
    app.kubernetes.io/name: kafka-exporter
spec:
  replicas: 1
  selector:
    matchLabels:
      app.kubernetes.io/name: kafka-exporter
  template:
    metadata:
      labels:
        app.kubernetes.io/name: kafka-exporter
    spec:
      containers:
      - name: exporter
        image: danielqsj/kafka-exporter:v1.6.0
        args:
        - --kafka.server=kafka:9092
        ports:
        - containerPort: 9308
          name: prometheus

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 un recurso de PodMonitoring

Para la detección de destinos, el operador de Managed Service para Prometheus requiere un recurso PodMonitoring que corresponda al exportador de Kafka 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: kafka-exporter
  labels:
    app.kubernetes.io/name: kafka-exporter
    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: kafka-exporter

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

Puede usar la siguiente configuración de Rules para definir alertas en sus métricas de Kafka:

# 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: kafka-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: kafka-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: kafka
    interval: 30s
    rules:
    - alert: KafkaChangeInNumberOfISRs
      annotations:
        description: |-
          Kafka change in number of isrs
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Kafka change in number of isrs (instance {{ $labels.instance }})
      expr: kafka_topic_partition_in_sync_replica != 10
      for: 5m
      labels:
        severity: critical
    - alert: KafkaUnderReplicatedPartitions
      annotations:
        description: |-
          Kafka under replicated partitions
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Kafka under replicated partitions (instance {{ $labels.instance }})
      expr: kafka_topic_partition_under_replicated_partition > 0
      for: 1m
      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.

Verificar la configuración

Puede usar el explorador de métricas para verificar que ha configurado correctamente el exportador de Kafka. 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 leaderboard 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 code MQL o code 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="kafka-exporter", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Ver paneles de control

La integración de Cloud Monitoring incluye el panel de control Resumen de Kafka Prometheus. 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, Resumen de Prometheus de Kafka).

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 Apache Kafka 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.