Jenkins

このドキュメントでは、Google Cloud Managed Service for Prometheus を使用して Jenkins エクスポータから指標を収集できるように、Google Kubernetes Engine の Deployment を構成する方法について説明します。このドキュメントでは、次の方法について説明します。

Jenkins エクスポータを設定して指標を報告します。
エクスポートされた指標を収集するために、Managed Service for Prometheus の PodMonitoring リソースを構成する。
Cloud Monitoring のダッシュボードにアクセスして指標を表示する。
指標をモニタリングするようにアラートルールを構成する。

以下の手順は、Managed Service for Prometheus でマネージドコレクションを使用している場合にのみ適用されます。セルフデプロイコレクションを使用している場合は、Jenkins のドキュメントでインストール情報をご覧ください。

以下の手順は一例であり、ほとんどの Kubernetes 環境で機能します。セキュリティポリシーや組織のポリシーの制限により、アプリケーションやエクスポータのインストールに問題がある場合は、オープンソースドキュメントでサポートを確認することをおすすめします。

Jenkins の詳細については、Jenkins をご覧ください。

前提条件

Managed Service for Prometheus とマネージドコレクションを使用して Jenkins エクスポータから指標を収集するには、Deployment が次の要件を満たしている必要があります。

クラスタで Google Kubernetes Engine バージョン 1.21.4-gke.300 以降を実行している必要があります。
マネージドコレクションを有効にして、Managed Service for Prometheus を実行する必要があります。詳細については、マネージドコレクションを使ってみるをご覧ください。
Jenkins とのインテグレーションに Cloud Monitoring で利用可能なダッシュボードを使用するには、jenkins バージョン 2.0.11 以降を使用する必要があります。
利用可能なダッシュボードの詳細については、ダッシュボードを表示するをご覧ください。

Jenkins は、Metrics プラグインと Prometheus プラグインをインストールした後でのみ、Prometheus 形式の指標を公開します。

Jenkins コミュニティ Helm チャートをインストールしている場合は、controller.installPlugins の値フィールドに Metrics プラグインと Prometheus プラグインを追加できます。

  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

また、次の Dockerfile で独自の Jenkins コンテナイメージを作成することもできます。

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

想定されるエンドポイントで Jenkins エクスポータが指標を出力していることを確認するには、次の操作を行います。

次のコマンドを使用してポート転送を設定します。
```
kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080
```
別のターミナルセッションでブラウザまたは curl ユーティリティを使用して、localhost:8080/prometheus エンドポイントにアクセスします。

PodMonitoring リソースを定義する

ターゲットディスカバリの場合、Managed Service for Prometheus Operator には、同じ Namespace 内の Jenkins エクスポータに対応する PodMonitoring リソースが必要です。

次の 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

port フィールドと matchLabels フィールドの値がモニタリング対象の Jenkins Pod の値と一致することを確認します。デフォルトでは、Jenkins の Helm インストールには port の値が http で、値が jenkins の app.kubernetes.io/name ラベルが含まれています。

構成の変更をローカルファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールとアラートを定義する

次の Rules 構成を使用して、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

構成の変更をローカルファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールをクラスタに適用する方法については、マネージドルールの評価とアラートをご覧ください。

アラートのしきい値は、アプリケーションに合わせて調整できます。

構成を確認する

Metrics Explorer を使用すると、Jenkins エクスポータが正しく構成されていることを確認できます。Cloud Monitoring が指標を取り込むまでに 1～2 分かかる場合があります。

指標が取り込まれていることを確認します。

Google Cloud コンソールのナビゲーションパネルで [Monitoring] を選択し、次に [ Metrics Explorer] を選択します。
Metrics Explorer に移動
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] で [PromQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定と同じツールバーにあります。

次のクエリを入力して実行します。

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

ダッシュボードを表示する

Cloud Monitoring インテグレーションには、Jenkins Prometheus の概要ダッシュボードが含まれています。ダッシュボードは、インテグレーションを構成すると自動的にインストールされます。インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

Google Cloud コンソールのナビゲーションパネルで、[Monitoring] を選択してから、[ダッシュボード] を選択します。
[ダッシュボード] に移動
[ダッシュボードリスト] タブを選択します。
[統合] カテゴリを選択します。
ダッシュボードの名前（Jenkins Prometheus Overview など）をクリックします。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

Google Cloud コンソールのナビゲーションパネルで、[Monitoring] を選択してから、[インテグレーション] を選択します。
[インテグレーション] に移動
[デプロイメントプラットフォーム] フィルタの [Kubernetes Engine] をクリックします。
Jenkins インテグレーションを見つけ、[詳細を表示] をクリックします。
[ダッシュボード] タブを選択します。

トラブルシューティング

指標の取り込みに関する問題のトラブルシューティングについては、取り込み側の問題のトラブルシューティングのエクスポータからの収集に関する問題をご覧ください。