Questa pagina è stata tradotta dall'API Cloud Translation.

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 metriche dall'esportatore di Jenkins. Questo documento spiega come effettuare le seguenti operazioni:

Configura l'utilità di esportazione di Jenkins per generare report sulle metriche.
Configura una risorsa PodMonitoring per Managed Service for Prometheus per raccogliere le metriche esportate.
Accedi a una dashboard in Cloud Monitoring per visualizzare le metriche.
Configura 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 autonomo, 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 riscontri problemi durante l'installazione di un'applicazione o di un esportatore a causa di criteri dell'organizzazione o di sicurezza restrittivi, ti consigliamo di consultare la documentazione open source per l'assistenza.

Per informazioni su Jenkins, visita Jenkins.

Prerequisiti

Per raccogliere 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.21.4-gke.300 o successiva.
Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta Inizia a utilizzare la raccolta gestita.
Per utilizzare le dashboard disponibili in Cloud Monitoring per l'integrazione con Jenkins, devi utilizzare jenkins 2.0.11 o versioni successive.
Per saperne di più sulle dashboard disponibili, consulta Visualizzare le dashboard.

Jenkins espone le metriche in formato Prometheus solo dopo aver installato i plug-in Metrics e Prometheus.

Se hai installato il grafico Helm della community di Jenkins, puoi aggiungere i plug-in Metrics e Prometheus al 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 metriche sugli endpoint previsti: segui questi passaggi:

Configura il port forwarding con il comando seguente:

kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080

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

definisci una risorsa PodMonitoring

Per il rilevamento della destinazione, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring corrispondente all'esportatore Jenkins nello stesso spazio dei nomi.

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

Assicurati che i valori dei campi port e matchLabels corrispondano a quelli dei pod Jenkins che vuoi monitorare. Per impostazione predefinita, le installazioni Helm di Jenkins includono un valore port pari a http e un'etichetta app.kubernetes.io/name con il valore jenkins.

Per applicare modifiche alla configurazione da un file locale, esegui questo comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le tue configurazioni.

Definisci regole e avvisi

Puoi utilizzare la seguente configurazione di Rules per definire gli avvisi nelle 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 modifiche alla configurazione da un file locale, esegui questo comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le tue configurazioni.

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

Puoi regolare le soglie di avviso in base alle esigenze della tua applicazione.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'utilità di esportazione Jenkins. Cloud Monitoring potrebbe impiegare uno o due minuti per importare le metriche.

Per verificare che le metriche siano state importate:

Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi Metrics Explorer:
Vai a Metrics Explorer
Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è MQL o PromQL.
Verifica che sia selezionato PromQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.

Inserisci ed esegui la query seguente:

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

Visualizza dashboard

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

Per visualizzare una dashboard installata, segui questi passaggi:

Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi Dashboard:
Vai a Dashboard
Seleziona la scheda Elenco dashboard.
Scegli la categoria Integrazioni.
Fai clic sul nome della dashboard, ad esempio Jenkins Prometheus Overview.

Per visualizzare un'anteprima statica della dashboard:

Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi Integrazioni:
Vai a Integrazioni
Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
Individua l'integrazione di Jenkins e fai clic su Visualizza dettagli.
Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di importazione delle metriche, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi lato importazione.