Jenkins

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere le metriche da Jenkins. Questo documento mostra come eseguire le seguenti operazioni:

• Configurare Jenkins per la generazione di report sulle metriche.
• Accedere a una dashboard predefinita in Cloud Monitoring per visualizzare le metriche.
• Configurare le regole di avviso per monitorare le metriche.

Queste istruzioni si applicano solo se utilizzi la raccolta gestita con Managed Service per Prometheus. Se utilizzi la raccolta con deployment automatico, consulta la documentazione di Jenkins per informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se hai difficoltà a installare un'applicazione o un esportatore a causa di politiche di sicurezza o organizzative restrittive, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su Jenkins, vedi Jenkins.

Prerequisiti

Per raccogliere le metriche dall' esportatore Jenkins utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:

• Il cluster deve eseguire Google Kubernetes Engine versione 1.28.15-gke.2475000 o successive.
• Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta la guida introduttiva alla raccolta gestita.

• Per utilizzare le dashboard disponibili in Cloud Monitoring per l' integrazione di Jenkins, devi utilizzare la jenkins versione 2.0.11 o successive.

  Per maggiori informazioni sulle dashboard disponibili, consulta Visualizza dashboard.

Se hai installato il grafico Helm della community di Jenkins, puoi aggiungere i plug-in Metrics e Prometheus nel campo dei valori 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
  

In alternativa, puoi creare la tua immagine container Jenkins con il seguente Dockerfile:

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

Per verificare che l'esportatore Jenkins emetta le metriche sugli endpoint previsti, procedere come segue:

1. Configura l'inoltro della porta con il seguente comando:

   kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080
   

2. Accedi all'endpoint localhost:8080/prometheus utilizzando il browser o l'utilità curl in un'altra sessione del terminale.

Definisci una risorsa PodMonitoring

Per l'individuazione dei target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore Jenkins nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione 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

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definisci regole e avvisi

Puoi utilizzare la seguente configurazione Rules per definire gli avvisi sulle metriche di 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

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per maggiori informazioni sull'applicazione delle regole al cluster, consulta Valutazione e avvisi delle regole gestite.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore Jenkins. Cloud Monitoring potrebbe richiedere uno o due minuti per inserire le metriche.

Per verificare che le metriche siano inserite:

1. Nella Google Cloud console, vai alla leaderboard Esplora metriche pagina:

   Vai a Esplora metriche

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è code PromQL.
3. Inserisci ed esegui la seguente query:
   

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

Visualizza dashboard

L'integrazione di Cloud Monitoring include la dashboard Jenkins Prometheus Overview. Le dashboard vengono installate automaticamente quando configuri l'integrazione. Puoi anche visualizzare le anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

1. Nella Google Cloud console, vai alla pagina dashboard Dashboard:

   Vai a Dashboard

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Seleziona la scheda Elenco dashboard.
3. Scegli la categoria Integrazioni.
4. Fai clic sul nome della dashboard, ad esempio Jenkins Prometheus Overview.

Per visualizzare un'anteprima statica della dashboard:

1. Nella Google Cloud console, vai alla  pagina Integrazioni:

   Vai a Integrazioni

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
3. Individua l'integrazione di Jenkins e fai clic su Visualizza dettagli.
4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di inserimento delle metriche, vedi Problemi con la raccolta dagli esportatori in Risoluzione dei problemi relativi all'inserimento.