Argo Workflows

このドキュメントでは、Google Cloud Managed Service for Prometheus を使用して Workflows Controller から指標を収集できるように、Google Kubernetes Engine のデプロイを構成する方法について説明します。このドキュメントでは、次の方法について説明します。

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

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

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

Workflows については、Argo Workflows をご覧ください。

前提条件

Managed Service for Prometheus とマネージドコレクションを使用して Workflows Controller から指標を収集するには、デプロイが次の要件を満たしている必要があります。

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

Workflows は、Prometheus 形式の指標を自動的に公開します。別途インストールする必要はありません。予想されるエンドポイントで Workflows Controller が指標を出力していることを確認するには、次の操作を行います。

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

PodMonitoring リソースを定義する

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

次の PodMonitoring 構成を使用できます。

# Copyright 2023 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
#
#     https://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: argo-workflows-controller
  labels:
    app.kubernetes.io/name: argo-workflows-controller
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 9090
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app: workflow-controller

port フィールドと matchLabels フィールドの値がモニタリング対象の Workflows Pod の値と一致していることを確認します。デフォルトでは、Workflows はポート 9090 で指標を公開し、ラベル app: workflow-controller を含みます。

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

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

次の Rules 構成を使用して、Workflows 指標に関するアラートを定義できます。

# Copyright 2023 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
#
#     https://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: argo-workflows-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: argo-workflows-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: argo-workflows
    interval: 30s
    rules:
    - alert: ArgoWorkflowsWorkflowErrors
      annotations:
        description: |-
          Argo Workflows workflow errors
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Argo Workflows workflow errors (instance {{ $labels.instance }})
      expr: argo_workflows_error_count > 0
      for: 5m
      labels:
        severity: critical

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

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

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

構成を確認する

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

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

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

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

up{job="argo-workflows-controller", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

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

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

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

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

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

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

トラブルシューティング

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