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 dall'esportatore di Jenkins. Questo documento illustra come:
- Configura l'esportatore di Jenkins per generare report sulle metriche.
- Configura una risorsa PodMonitoring per Managed Service per 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 una raccolta di cui è stato eseguito il 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 norme restrittive di sicurezza o dell'organizzazione, ti consigliamo di consultare la documentazione open source per ricevere assistenza.Per informazioni su Jenkins, visita il sito Jenkins.
Prerequisiti
Per raccogliere metriche dall'esportatore di Jenkins utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:
- Nel cluster deve essere in esecuzione Google Kubernetes Engine versione 1.21.4-gke.300 o successive.
- Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta Iniziare a utilizzare la raccolta gestita.
- Per utilizzare le dashboard disponibili in Cloud Monitoring per l'integrazione con Jenkins, devi usare
jenkins
versione 2.0.11 o successive.Per saperne di più sulle dashboard disponibili, consulta Visualizzare le dashboard.
Se hai installato il grafico Helm della community 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 di Jenkins stia emettendo metriche sugli endpoint previsti, segui questi passaggi:
Configura il port forwarding con il seguente comando:
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 del terminale.
Definisci una risorsa PodMonitoring
Per il rilevamento della destinazione, 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 di PodMonitoring:
Assicurati che i valori dei campiport
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 le 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 configurazioni.
Definisci regole e avvisi
Puoi utilizzare la seguente configurazione di Rules
per definire gli avvisi nelle metriche Jenkins:
Per applicare le 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 configurazioni.
Per saperne di più sull'applicazione di regole al cluster, consulta Valutazione e avvisi delle regole gestite.
Puoi regolare le soglie di avviso in base alla tua applicazione.Verificare la configurazione
Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore di Jenkins. L'importazione delle metriche da parte di Cloud Monitoring potrebbe richiedere uno o due minuti.
Per verificare che le metriche siano importate:
-
Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Nella barra degli strumenti del riquadro di creazione di query, seleziona il pulsante con il nome code MQL o code PromQL.
- Verifica che l'opzione PromQL sia selezionata nell'opzione di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
- Inserisci ed esegui questa query:
up{job="jenkins", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
Visualizza dashboard
L'integrazione di Cloud Monitoring include la dashboard Panoramica di Jenkins 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:
-
Nella console Google Cloud, vai alla pagina Dashboard :
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Seleziona la scheda Elenco dashboard.
- Scegli la categoria Integrations (Integrazioni).
- Fai clic sul nome della dashboard, ad esempio Panoramica di Jenkins Prometheus.
Per visualizzare un'anteprima statica della dashboard:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
- Individua l'integrazione con 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.