IBM Cloud Docs
Continuous Delivery のモニタリング・メトリック

Continuous Delivery のモニタリング・メトリック

IBM Cloud® Monitoring は、IBM Cloud アーキテクチャーの一部として組み込み可能なサード・パーティー製なおかつクラウドネイティブのコンテナー・インテリジェンス管理システムです。 このシステムを使用して、アプリケーション、サービス、およびプラットフォームのパフォーマンスと正常性について、運用の可視化が可能になります。 モニター、トラブルシューティング、アラートの定義、カスタム・ダッシュボードの設計のための拡張機能により、管理者、DevOps チーム、開発者のフルスタック・テレメトリーを提供します。

プラットフォームのメトリックの概要

プラットフォームのメトリックを収集するために構成できる IBM Cloud Monitoring サービス・インスタンスは、リージョンごとに 1 つだけです。

  • モニタリング・インスタンスを構成するには、プラットフォーム・メトリックの構成を設定する必要があります。
  • リージョン内のモニタリング・インスタンスでプラットフォーム・メトリックの収集が既に有効になっている場合は、モニタリング対応サービスからメトリックが自動的に収集されていて、このインスタンスでモニタリングできるようになっています。
  • アカウントとリージョンのモニタリング・インスタンスでプラットフォーム・インスタンスを収集できるようになると、同じアカウントとリージョン内のすべての Continuous Delivery サービス・インスタンスからメトリックを自動的に収集します。 Continuous Delivery サービス・メトリックの収集をオプトインする必要はありません。 また、Continuous Delivery サービス・メトリックの収集をオプトアウトすることはできません。

プラットフォーム・メトリックをモニターするには、IBM Cloud Monitoring インスタンスがプロビジョンされているのと同じリージョンで Continuous Delivery インスタンスがプロビジョンされていることを確認します。

Continuous Delivery ダッシュボードからのプラットフォーム・メトリックの有効化

プラットフォーム・メトリックを構成するには、以下のステップを実行します。

  1. IBM Cloud にログインします。

  2. リソースリストをクリックする。

  3. サービスとソフトウェア ・セクションで、監視する予定の Continuous Delivery インスタンスをクリックします。

  4. 「管理」 ページで、 「アクション」 > 「モニタリングの追加」 をクリックして、 Continuous Delivery インスタンスの領域で プラットフォーム・メトリック を構成します。

    メニュー選択項目に**「モニタリング」**オプションが含まれている場合、その Continuous Delivery インスタンスが含まれるアカウントとリージョンではプラットフォーム・メトリックが既に構成されています。

  5. IBM Cloud Monitoring サービスのインスタンスをプロビジョンします。

    モニタリング・インスタンスをプロビジョンすると、「プログラム識別情報」ページが開きます。 引き続き Continuous Delivery を扱うには、Continuous Delivery UI に戻ります。

メトリックは、 Tekton パイプラインをセットアップ し、少なくとも 1 つの プライベート・ワーカー ・プールを構成し、いくつかの Tekton パイプライン・トリガー をトリガーしてキュー時間メトリックを生成するまで表示されません。

メトリックの表示

Continuous Delivery メトリックをモニターするには、Continuous Delivery インスタンスが使用可能なリージョンで、プラットフォーム・メトリックに対して使用可能になっているモニタリング Web UI インスタンスを起動する必要があります。

モニタリング Web UI を起動し、メトリックをモニターするにはいくつかのオプションがあります。

Continuous Delivery ダッシュボードからのモニタリング Web UI の起動

Continuous Delivery ダッシュボードからモニタリング Web UI を起動するには、以下のステップを実行します。

  1. IBM Cloud にログインします。

  2. リソースリストをクリックする。

  3. サービスとソフトウェア ・セクションで、監視する予定の Continuous Delivery インスタンスをクリックします。

  4. 「管理」 ページで、 「アクション」 > 「モニター」 をクリックして、 Continuous Delivery インスタンスのコンテキスト内の Continuous Delivery ダッシュボードを表示します。

「プログラム識別情報」ページからのモニタリング Web UI の起動

**「プログラム識別情報」**ページからモニタリング Web UI を起動するには、以下のステップを実行します。

  1. IBM Cloud にログインします。
  2. モニタリング UI を起動します。
  3. Observabilityをクリックし、 Monitoringを選択する。
  4. IBM Cloudで使用可能なインスタンスのリストから、モニターする Continuous Delivery のインスタンスを選択します。 次に、**「ダッシュボードを開く (Open Dashboard)」**をクリックします。

Continuous Delivery インスタンスをモニターするには、スコープを変更するか、デフォルト・ダッシュボードのコピーを作成します。

Continuous Delivery の Monitoring

Continuous Delivery サービス・インスタンスをモニターするときには以下のタスクを検討します。

Continuous Delivery監視タスク
タスク 事前定義アラート 確認すべき点
プライベート・パイプラインのワーカー・プールでデリバリー・パイプラインの実行を開始する前に、キューに留まる長さをモニターする。 Continuous Delivery パイプライン・キュー時間 キュー時間が繰り返し 10 秒を超える場合、プライベート・ワーカー・プールには、要求されているパイプライン実行を処理するだけの十分な容量がない可能性があります。 ワーカー・プールのスケール・アップ、ワーカー・プールの新規作成、パイプライン実行数の削減が必要になることがあります。

デリバリー・パイプラインのキュー時間のモニター

説明

パイプライン・キュー時間は、パイプラインを実行する要求を Continuous Delivery サービスが受信してキューに入れてから、パイプラインの実行をプライベート・ワーカー・プールがデキューして開始するまでの経過時間を秒単位で追跡します。 パイプライン要求は、プライベート・ワーカー・プールで扱われるまでのキューでの経過時間が 1、2 秒であるのが理想的です。 パイプライン要求がキューに数秒または数分留まる場合には、プライベート・ワーカー・プールに、着信パイプライン・ワークロードを処理するための容量が不足している可能性があります。 パイプラインのキュー時間が 10 秒などの妥当なしきい値を超える場合にアラートが示されると、プライベート・ワーカー・プールをスケール・アップする必要があることに注意を向けるのに役立ちます。

ユーザー・アクション

モニタリングの Continuous Delivery ダッシュボードを利用すると、パイプラインのキュー時間の傾向を識別できます。 パイプラインのキュー時間が直近の数秒間にわたりプライベート・ワーカー・プールにサービス提供していたり、キュー時間が上昇傾向にあったりする場合には、プール内のノードの数や処理能力など、プライベート・ワーカー・プールの構成を確認してください。 プライベート・ワーカー・プールをスケール・アップするか、プライベート・ワーカー・プールにディスパッチされるパイプラインのジョブおよびタスクの頻度、種類、または複雑性を減らすことによって、キュー時間を短くできることがあります。

Continuous Delivery 事前定義ダッシュボード

以下の表に、Continuous Delivery メトリックをモニターするときに使用できる事前定義ダッシュボードの概要を示します。

事前定義ダッシュボード
ダッシュボード名 説明
Continuous Delivery サービス・インスタンス UI からモニタリング Web UI を起動するときのデフォルトのダッシュボード。

デフォルト・ダッシュボードは変更できません。 ダッシュボードをカスタマイズする場合、コピーを作成できます。

サービス・プランで使用可能なメトリック

表 3: プラン名別の使用可能なメトリック
メトリック名 ライト Professional
パイプラインのキュー時間 チェック・マーク・アイコン チェック・マーク・アイコン
パイプラインの走行時間 チェック・マーク・アイコン チェック・マーク・アイコン

事前定義アラート

以下の表に、モニタリングで使用できる事前定義アラートの概要を示します。

事前定義されたアラート
アラート名 説明
Continuous Delivery 高パイプライン・キュー時間 このアラートは、パイプライン要求のキュー時間をモニターし、プライベート・ワーカー・プールによる要求の処理に時間がかかりすぎているかどうかを通知します。

Continuous Delivery メトリック・ディクショナリー

パイプラインのキュー時間

パイプラインを実行する要求を Continuous Delivery サービスが受信してキューに入れてから、パイプラインの実行をプライベート・ワーカー・プールがデキューして開始するまでの経過時間 (秒単位)。

表 5: パイプラインのキュー時間のメトリック・メタデータ
メタデータ 説明
Metric Name ibm_toolchain_pipeline_queue_time_seconds
Metric Type gauge
Value Type second
Segment By Service instance, Service instance name, Private worker pool ID

パイプラインの走行時間

パイプラインの実行がワーカーで実行され始めてから、すべてのタスクが完了するまでの経過時間 (秒)。

表5：パイプラインの実行期間メトリックのメタデータ
メタデータ 説明
Metric Name ibm_toolchain_pipeline_run_duration_seconds
Metric Type gauge
Value Type second
Segment By Pipeline ID and Trigger name

セグメント化のための属性

グローバル属性

以下の属性は、このトピックでリストされているすべてのメトリックのセグメント化に使用できます。

グローバル・セグメンテーションの属性
属性 属性名 属性の説明 有効な値
Cloud Type ibm_ctype Cloud のタイプ 有効な値は public または localです。
Location ibm_location モニター対象リソースのロケーション。 リージョン、データ・センター、または global を指定できます。
Resource group ibm_resource_group_name サービス・インスタンスに関連付けられているリソース・グループ。 アカウントで使用可能なリソース・グループのいずれかを選択します。
Scope ibm_scope 対象となるデータ・サンプルの範囲。 スコープとしてアカウント、組織、またはこのメトリックに関連付けられているスペース GUID を選択できます。
Service name ibm_service_name このメトリックを生成するサービスの名前。 toolchain

追加の属性

以下の属性は、1 つ以上のグローバル属性のセグメント化に使用できます。

サポートされているセグメント化オプションについては、個々のメトリックを確認してください。

追加のセグメンテーションの属性
属性 属性名 属性の説明
Private worker pool ibm_toolchain_pipeline_worker_pool Continuous Delivery パイプラインのプライベート・ワーカー・プールの固有 ID。