Jenkins

En este documento, se describe cómo configurar tu implementación de Google Kubernetes Engine a fin de que puedas usar Google Cloud Managed Service para Prometheus para recopilar métricas del exportador de Jenkins. Este documento te muestra cómo hacer lo siguiente:

Configurar el exportador de Jenkins para informar las métricas
Configurar un recurso PodMonitoring a fin de que Managed Service para Prometheus recopile las métricas exportadas.
Acceder a un panel en Cloud Monitoring para ver las métricas
Configura reglas de alerta para supervisar las métricas

Estas instrucciones se aplican solo si usas la colección administrada con Managed Service para Prometheus. Si usas la colección implementada de forma automática, consulta la documentación de Jenkins para obtener información sobre la instalación.

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

Para obtener información sobre Jenkins, consulta Jenkins.

Requisitos previos

Para recopilar métricas del exportador de Jenkins mediante el servicio administrado de Prometheus y la colección administrada, tu implementación debe cumplir con los siguientes requisitos:

Tu 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 colección administrada habilitada. Para obtener más información, consulta Primeros pasos con la recopilación administrada.
Si deseas usar los paneles disponibles en Cloud Monitoring para la integración de Jenkins, debes usar la versión 2.0.11 de jenkins o una posterior.
Para obtener más información sobre los paneles disponibles, consulta Visualiza los paneles.

Jenkins expone métricas de formato de Prometheus solo después de instalar los complementos de métricas y Prometheus.

Si instalaste el gráfico de Helm de la comunidad de Jenkins, puedes agregar los complementos de métricas y Prometheus en el campo de valores controller.installPlugins:

  controller:
    installPlugins:
      - kubernetes:3734.v562b_b_a_627ea_c
      - workflow-aggregator:590.v6a_d052e5a_a_b_5
      - git:4.13.0
      - configuration-as-code:1569.vb_72405b_80249
      - metrics
      - prometheus:2.0.11

Como alternativa, puedes crear tu propia imagen de contenedor de Jenkins con el siguiente Dockerfile:

  FROM jenkins/jenkins:lts
  RUN jenkins-plugin-cli --plugins prometheus metrics

Para verificar que el exportador de Jenkins emita las métricas en los extremos esperados, haz lo siguiente:

Configure la redirección de puertos con el siguiente comando:
```
kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080
```
Accede al extremo localhost:8080/prometheus mediante el navegador o la utilidad curl en otra sesión de la 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 Jenkins 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: jenkins
  labels:
    app.kubernetes.io/name: jenkins
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: http
    scheme: http
    interval: 30s
    path: /prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: jenkins

Asegúrate de que los valores de los campos port y matchLabels coincidan con los de los Pods de Jenkins que deseas supervisar. De forma predeterminada, las instalaciones de Helm de Jenkins incluyen un valor port de http y una etiqueta app.kubernetes.io/name con el valor jenkins.

Para aplicar los 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 tus opciones de configuración.

Define reglas y alertas

Puedes usar la siguiente configuración Rules para definir alertas en las métricas de Jenkins:

# 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: jenkins-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: jenkins-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: jenkins
    interval: 30s
    rules:
    - alert: JenkinsHealthScoreBelowOne
      annotations:
        description: |-
          Jenkins health score below one
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Jenkins health score below one (instance {{ $labels.instance }})
      expr: jenkins_health_check_score < 1
      for: 5m
      labels:
        severity: critical
    - alert: JenkinsPluginFailure
      annotations:
        description: |-
          Jenkins plugin failure
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Jenkins plugin failure (instance {{ $labels.instance }})
      expr: jenkins_plugins_failed > 0
      for: 5m
      labels:
        severity: critical

Para aplicar los 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 tus opciones de configuración.

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

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

Verifica la configuración

Puedes usar el Explorador de métricas para verificar que configuraste correctamente el exportador de Jenkins. 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:

En la consola de Google Cloud, ve a la página Explorador de métricas:
Ir 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.
En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre sea MQL o PromQL.
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 te permite dar formato a tu consulta.

Ingresa y ejecuta la siguiente consulta:

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

Ver paneles

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

Para ver un panel instalado, haz lo siguiente:

En la consola de Google Cloud, ve a la página Paneles.
Dirígete a Paneles de control

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Selecciona la pestaña Lista de paneles.
Elige la categoría Integraciones.
Haz clic en el nombre del panel, por ejemplo, Jenkins Prometheus Overview.

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

En la consola de Google Cloud, ve a la página Integraciones:
Dirígete a Integraciones

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Haz clic en el filtro de la plataforma de implementación Kubernetes Engine.
Encuentra la integración de Jenkins y haz clic en Ver detalles.
Selecciona la pestaña Paneles.

Soluciona problemas

Para obtener información sobre la solución de problemas de transferencia de métricas, consulta Problemas de recopilación de exportadores en Solución de problemas de transferencia.