Jenkins

Dokumen ini menjelaskan cara mengonfigurasi deployment Google Kubernetes Engine sehingga Anda dapat menggunakan Google Cloud Managed Service for Prometheus untuk mengumpulkan metrik dari Jenkins. Dokumen ini menunjukkan cara melakukan hal berikut:

  • Menyiapkan Jenkins untuk melaporkan metrik.
  • Mengakses dasbor standar di Cloud Monitoring untuk melihat metrik.
  • Mengonfigurasi aturan pemberitahuan untuk memantau metrik.

Petunjuk ini hanya berlaku jika Anda menggunakan koleksi terkelola dengan Managed Service for Prometheus. Jika Anda menggunakan koleksi yang di-deploy sendiri, lihat dokumentasi Jenkins untuk mengetahui informasi penginstalan.

Petunjuk ini disediakan sebagai contoh dan diharapkan berfungsi di sebagian besar lingkungan Kubernetes. Jika Anda mengalami masalah saat menginstal aplikasi atau pengekspor karena kebijakan organisasi atau keamanan yang ketat, sebaiknya lihat dokumentasi open source untuk mendapatkan dukungan.

Untuk mengetahui informasi tentang Jenkins, lihat Jenkins.

Prasyarat

Untuk mengumpulkan metrik dari pengekspor Jenkins menggunakan Managed Service for Prometheus dan koleksi terkelola, deployment Anda harus memenuhi persyaratan berikut:

  • Cluster Anda harus menjalankan Google Kubernetes Engine versi 1.28.15-gke.2475000 atau yang lebih baru.
  • Anda harus menjalankan Managed Service for Prometheus dengan koleksi terkelola yang diaktifkan. Untuk mengetahui informasi selengkapnya, lihat Mulai menggunakan koleksi terkelola.

  • Untuk menggunakan dasbor yang tersedia di Cloud Monitoring untuk integrasi Jenkins, Anda harus menggunakan jenkins versi 2.0.11 atau yang lebih baru.

    Untuk mengetahui informasi selengkapnya tentang dasbor yang tersedia, lihat Melihat dasbor.

Jenkins hanya menampilkan metrik format Prometheus setelah Anda menginstal plugin Metrics dan Prometheus.

Jika menginstal diagram helm komunitas Jenkins, Anda dapat menambahkan plugin Metrics dan Prometheus di kolom nilai 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

Atau, Anda dapat membuat image container Jenkins sendiri dengan Dockerfile berikut:

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

Untuk memverifikasi bahwa pengekspor Jenkins memancarkan metrik di endpoint yang diharapkan, lakukan hal berikut:

  1. Siapkan penerusan port dengan perintah berikut:

    kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080

  2. Akses endpoint localhost:8080/prometheus menggunakan browser atau utilitas curl di sesi terminal lain.

Menentukan resource PodMonitoring

Untuk penemuan target, Managed Service for Prometheus Operator memerlukan resource PodMonitoring yang sesuai dengan pengekspor Jenkins di namespace yang sama.

Anda dapat menggunakan konfigurasi PodMonitoring berikut:

# 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
Pastikan nilai kolom port dan matchLabels cocok dengan pod Jenkins yang ingin Anda pantau. Secara default, penginstalan Jenkins Helm menyertakan nilai port http dan label app.kubernetes.io/name dengan nilai jenkins.

Untuk menerapkan perubahan konfigurasi dari file lokal, jalankan perintah berikut: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Anda juga dapat menggunakan Terraform untuk mengelola konfigurasi.

Menentukan aturan dan pemberitahuan

Anda dapat menggunakan konfigurasi Rules berikut untuk menentukan pemberitahuan pada metrik 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

Untuk menerapkan perubahan konfigurasi dari file lokal, jalankan perintah berikut: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Anda juga dapat menggunakan Terraform untuk mengelola konfigurasi.

Untuk mengetahui informasi selengkapnya tentang cara menerapkan aturan ke cluster, lihat Evaluasi dan pemberitahuan aturan terkelola.

Anda dapat menyesuaikan nilai minimum pemberitahuan agar sesuai dengan aplikasi.

Memverifikasi konfigurasi

Anda dapat menggunakan Metrics Explorer untuk memverifikasi bahwa Anda telah mengonfigurasi pengekspor Jenkins dengan benar. Cloud Monitoring mungkin memerlukan waktu satu atau dua menit untuk menyerap metrik Anda.

Untuk memverifikasi bahwa metrik telah diserap, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Metrics explorer:

    Buka Metrics explorer

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Di toolbar panel pembuat kueri, pilih tombol yang namanya  PromQL.
  3. Masukkan dan jalankan kueri berikut:
    up{job="jenkins", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Melihat dasbor

Integrasi Cloud Monitoring mencakup dasbor Jenkins Prometheus Overview. Dasbor akan otomatis diinstal saat Anda mengonfigurasi integrasi. Anda juga dapat melihat pratinjau statis dasbor tanpa menginstal integrasi.

Untuk melihat dasbor yang terinstal, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Dashboards:

    Buka Dashboards

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Pilih tab Dashboard List.
  3. Pilih kategori Integrations.
  4. Klik nama dasbor, misalnya, Jenkins Prometheus Overview.

Untuk melihat pratinjau statis dasbor, lakukan hal berikut:

  1. Di Google Cloud konsol, buka halaman  Integrations:

    Buka Integrations

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

  2. Klik filter platform deployment Kubernetes Engine.
  3. Temukan integrasi Jenkins, lalu klik View Details.
  4. Pilih tab Dashboards.

Pemecahan masalah

Untuk mengetahui informasi tentang cara memecahkan masalah penyerapan metrik, lihat Masalah dengan pengumpulan dari pengekspor di Memecahkan masalah sisi penyerapan.