可観測性

手順

1. OpenShift Container Platform Web コンソールで、 メニュー → Observability → Logging に移動して Kibana ダッシュボードを表示します。

2. インデックスパターンを作成します。

   1. すべてのインデックスを表示するには、インデックスパターンを * と定義し、Next step をクリックします。
   2. Time Filter field name で @timestamp を選択します。
   3. Create index pattern をクリックします。
3. Kibana ダッシュボードのナビゲーションパネルで、Discover タブをクリックします。

4. Argo CD のログを取得するフィルターを作成します。次の手順では、openshift-gitops namespace 内のすべての Pod のログを取得するフィルターを作成します。

   1. Add a filter + をクリックします。
   2. kubernetes.namespace_name フィールドを選択します。
   3. is 演算子を選択します。
   4. openshift-gitops 値を選択します。
   5. Save をクリックします。
5. オプション: フィルターを追加して検索を絞り込みます。たとえば、特定の Pod のログを取得するには、フィールドとして kubernetes.pod_name を使用して別のフィルターを作成できます。
6. Kibana ダッシュボードでフィルタリングされた Argo CD ログを表示します。

手順

1. Web コンソールの Administrator パースペクティブで、Observe → Dashboards に移動します。
2. Dashboard ドロップダウンリストから、目的の GitOps ダッシュボード (GitOps (Overview)、GitOps / Components、GitOps / gRPC Services、または GitOps / Rollouts を選択します。
3. オプション: Namespace、Cluster、および Interval ドロップダウンリストから特定の namespace、クラスター、および間隔を選択します。
4. GitOps ダッシュボードで必要な GitOps メトリクスを表示します。

手順

1. Web コンソールの Developer パースペクティブで、Argo CD アプリケーションがインストールされている namespace を選択し、Observe → Metrics に移動します。
2. Select query ドロップダウンリストから、Custom query を選択します。

3. Argo CD アプリケーションのヘルスステータスを確認するには、Expression フィールドに、次の例のような Prometheus Query Language (PromQL) クエリーを入力します。

   例

   sum(argocd_app_info{dest_namespace=~"<your_defined_namespace>",health_status!=""}) by (health_status) 

   1

   Copy to Clipboard Toggle word wrap

   1

   <your_define_namespace> 変数を、定義した namespace の実際の名前 (openshift-gitops など) に置き換えます。

手順

1. OpenShift Container Platform Web コンソールにログインします。
2. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators の順にクリックします。
3. Project リストから、ユーザー定義の Argo CD インスタンスがインストールされているプロジェクトを選択します。
4. インストールされた Operator のリストから Red Hat OpenShift GitOps を選択し、Argo CD タブに移動します。
5. ユーザー定義の Argo CD インスタンスをクリックします。

6. ユーザー定義の Argo CD インスタンスの ArgoCD CR を設定して、メトリクスの自動スクレイピングを無効にします。

   1. YAML タブをクリックし、ArgoCD CR の YAML ファイルを編集します。

   2. ArgoCD CR で、spec.monitoring.disableMetrics フィールドの値を true に設定します。

      ArgoCD CR の例

      apiVersion: argoproj.io/v1beta1
      kind: ArgoCD
      metadata:
       name: example  

      1

      
       namespace: spring-petclinic 

      2

      
      spec:
       monitoring:
         disableMetrics: true

      Copy to Clipboard Toggle word wrap

      1

      ユーザー定義の Argo CD インスタンスの名前。

      2

      ユーザー定義の Argo CD インスタンスを実行する namespace。

      ヒント

      または、Red Hat OpenShift GitOps argocd CLI でメトリクスの自動スクレイピングを無効にするには、次のコマンドを使用します。

      コマンドの例

      $ oc patch argocd example -n spring-petclinic --type='json' -p='[{"op": "replace", "path": "/spec/monitoring/disableMetrics", "value": true}]'

      Copy to Clipboard Toggle word wrap

      出力例

      argocd.argoproj.io/example patched

      Copy to Clipboard Toggle word wrap

7. Operator が定義した namespace に openshift.io/cluster-monitoring=false ラベルを追加したことを確認します。

   1. Administration → Namespaces に移動します。

      Namespaces ページには、作成された namespace が表示されます。

   2. 定義した namespace をクリックし、YAML タブに移動して、metadata.labels セクションの下に、Operator によって openshift.io/cluster-monitoring=false ラベルが追加されていることを確認します。

8. Operator が定義した namespace から次のリソースを削除することを確認します。

   1. Home → Search に移動します。

   2. Resources リストから、PrometheusRule、Role、RoleBinding、ServiceMonitors を選択します。

      Search ページには選択したリソースが表示されます。

   3. Search ページで、PrometheusRule セクションで、gitops-operator-argocd-alerts prometheus ルールが削除されていることを確認します。
   4. Roles セクションの Filter リストから、Namespace Roles を選択します。
   5. <argocd_namespace>-read ロールが削除されていることを確認します。
   6. RoleBindings セクションの Filter リストから、Namespace RoleBindings を選択します。
   7. <argocd_namespace>-prometheus-k8s-read-binding ロールバインディングが削除されていることを確認します。
   8. ServiceMonitors セクションで、<argocd_name>、<argocd_name>-repo-server、および <argocd_name>-server サービスモニターが削除されていることを確認します。

手順

1. Web コンソールの Administrator パースペクティブで、Observe → Metrics に移動します。

2. Expression フィールドにメトリクスを入力します。次のメトリクスから選択できます。

   • active_argocd_instances_total
   • active_argocd_instances_by_phase
   • active_argocd_instance_reconciliation_count
   • controller_runtime_reconcile_time_seconds_per_instance_bucket
   • controller_runtime_reconcile_time_seconds_per_instance_count
   • controller_runtime_reconcile_time_seconds_per_instance_sum

3. (オプション): プロパティーごとにメトリクスをフィルターします。たとえば、active_argocd_instances_by_phase メトリクスを Available フェーズでフィルターします。

   例

   active_argocd_instances_by_phase{phase="Available"}

   Copy to Clipboard Toggle word wrap

4. (オプション): Add query をクリックして、複数のクエリーを入力します。
5. Run queries をクリックして、GitOps Operator メトリクスを有効にして観察します。

手順

1. Developer パースペクティブの下の Environments をクリックします。Environments ページには、Environment status と共にアプリケーションの一覧が表示されます。
2. Environment status 列の下のアイコンの上にマウスをかざすと、すべての環境の同期ステータスが表示されます。
3. 一覧からアプリケーション名をクリックし、特定のアプリケーションの詳細を表示します。

4. Application environments ページで、Overview タブの Resources セクションにアイコンが表示されている場合は、アイコンにカーソルを合わせると、ステータスの詳細が表示されます。

   • ひびの入ったハートは、リソースの問題によってアプリケーションのパフォーマンスが低下したことを示します。
   • 黄色の逆三角形は、リソースの問題により、アプリケーションのヘルスに関するデータが遅れたことを示します。
5. アプリケーションのデプロイメント履歴を表示するには、Deployment History タブをクリックします。このページには、Last deployment、Description (コミットメッセージ)、Environment、Author、および Revision などの詳細が含まれます。

手順

1. 特定の Argo CD インスタンスで .spec.monitoring.enabled フィールドの値を true に設定します。

   Argo CD カスタムリソースの例

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: example-argocd
     labels:
       example: repo
   spec:
    # ...
     monitoring:
       enabled: true
    # ...

   Copy to Clipboard Toggle word wrap

2. Operator によって作成された PrometheusRule にアラートルールが含まれているかどうかを確認します。

   アラートルールの例

   apiVersion: monitoring.coreos.com/v1
   kind: PrometheusRule
   metadata:
     name: argocd-component-status-alert
     namespace: openshift-gitops
   spec:
     groups:
       - name: ArgoCDComponentStatus
         rules:
          # ...
           - alert: ApplicationSetControllerNotReady 

   1

   
             annotations:
               message: >-
                 applicationSet controller deployment for Argo CD instance in
                 namespace "default" is not running
             expr: >-
               kube_statefulset_status_replicas{statefulset="openshift-gitops-application-controller statefulset",
               namespace="openshift-gitops"} !=
               kube_statefulset_status_replicas_ready{statefulset="openshift-gitops-application-controller statefulset",
               namespace="openshift-gitops"}
             for: 1m
             labels:
               severity: critical

   Copy to Clipboard Toggle word wrap

   1

   Argo CD インスタンスによって作成されたワークロードが期待どおりに実行されているかどうかをチェックする PrometheusRule のアラートルール。