Code Engineをモニターするカスタム・ダッシュボードの作成
IBM Cloud Monitoring を使用して、Code Engineワークロードの正常性とパフォーマンスを可視化します。 Code Engineワークロード用にMonitoringダッシュボードをカスタマイズして、調整された一連のメトリックにすることで、ボトルネックを特定したり、発生する可能性のある生産問題を予測したりできます。
Code Engineをモニターするカスタム・ダッシュボードの作成
調整した一連のメトリックに合わせて、Code Engineワークロード用のカスタムMonitoringダッシュボードを作成できます。
Monitoringでカスタム・ダッシュボードを作成するには、まずCode Engineワークロードのモニターをセットアップしなければなりません。 Monitoringサービス・インスタンスをセットアップし、モニター対象のCode Engineプロジェクトと同じリージョンでプラットフォーム・メトリックを有効にします。 複数のリージョンにデプロイメントが存在する場合は、リージョンごとに Monitoring をプロビジョンしてプラットフォーム・メトリックを有効にする必要があります。 IBM Cloud Monitoringサービス・インスタンスのセットアップ、およびCode EngineワークロードをモニターするためのIBM Cloud Monitoringメトリック・ダッシュボードへのアクセスについて詳しくは、Code Engineのモニターを参照してください。
Code EngineにはIBM Code Engine Project Overview
ダッシュボードが用意されています。このダッシュボードは、Code Engineワークロードのさまざまな側面をモニターする事前定義パネルで構成されています。 Code Engineワークロード用のカスタム Monitoringダッシュボードを、調整した一連のメトリックに作成できます。
-
IBM Cloud Monitoring サービス・インスタンスをセットアップします。 アクティブな IBM Cloud Monitoring インスタンスを確認するには、「プログラム識別情報」ダッシュボードを参照してください。
-
使用可能なモニター・データがあることを確認してください。 モニターするデータがあるとカスタム・ダッシュボードの設計が容易になるため、アプリケーションまたはジョブを実行することが重要です。 一部のCode Engineメトリックは、環境内で使用可能な場合にのみ存在します。
-
Code Engineに使用可能なメトリックを確認します。
-
IBM Cloud Monitoringメトリックにアクセスします。
- IBM Cloud ナビゲーション・メニューの**「プログラム識別情報」**を選択します。
- **「モニタリング」**を選択します。
- ダッシュボードを開くをクリックして、モニター・インスタンスのダッシュボードを開きます。
- ナビゲーション・メニューから、「ダッシュボード->IBM->IBM Code Engineプロジェクトの概要」を選択します。 メニューに Code Engine ダッシュボードが表示されない場合は、**「モニタリングの起動」**を選択して、Code Engine アプリケーションまたはジョブからモニタリングを開始できます。
-
カスタム・ダッシュボードの作成をクリックして、
IBM Code Engine Project Overview
ダッシュボードのコピーを作成します。 カスタム・ダッシュボードの名前を入力し、作成して開くをクリックします。 例えば、ダッシュボードにMy custom IBM Code Engine Project Overview
という名前を付けます。 -
ダッシュボード・パネルを追加または削除して、ダッシュボードをカスタマイズします。 Code Engineアプリケーションおよびジョブ実行のワークロードをモニターするためにダッシュボードをカスタマイズする方法の例については、シナリオ 1および シナリオ 2を参照してください。 IBM Cloud Monitoringダッシュボードの操作について詳しくは、ダッシュボードの操作を参照してください。
ダッシュボードのレイアウトを変更する場合は、必ずレイアウトの保存をクリックして変更を保存してください。 ダッシュボードのカスタマイズを続行する前に、レイアウトの変更を保存するか、キャンセルしなければなりません。
-
カスタム・ダッシュボードを保存します。 カスタム・ダッシュボードは、ダッシュボードのナビゲーション・メニューダッシュボード-> マイ・ダッシュボードで使用できます。
シナリオ 1: Code Engineアプリケーション・インスタンスおよびジョブ実行に焦点を絞る
Code Engineワークロードのモニター範囲を絞り込み、実行中のアプリケーションおよびジョブ実行のインスタンスに焦点を合わせます。 この情報をモニターすると便利な場合があります。アプリケーションがゼロにスケーリングされる場合や、ジョブまたはビルドが実行されていない場合は、リソースが消費されないためです。 このシナリオでは、既存のIBM Code Engine Project Overview
ダッシュボードから以前に作成したMy custom IBM Code Engine Project Overview
ダッシュボードを使用し、パネルを変更および削除することでカスタム・ダッシュボードを単純化します。
-
カスタム・ダッシュボードを開きます。 このシナリオでは、
IBM Code Engine Project Overview
ダッシュボードのコピーから開始することを想定しています。 カスタム・ダッシュボードは、ダッシュボードのナビゲーション・メニューダッシュボード-> マイ・ダッシュボードで使用できます。 -
Total number of Applications
数値パネルを変更し、ibm_codeengine_application_actual_instances
メトリックを使用して実際のインスタンス数を表示するように照会を変更します。- パネルを編集するには、鉛筆アイコンをクリックします。
- 照会タブで、
ibm_codeengine_application_service_count
メトリックをクリックして、メトリックを変更します。 Code Engineメトリックのリストを表示するには、ibm_codeengine_
と入力します。 この例では、ibm_codeengine_application_actual_instances
メトリックを選択し、Maximum
時間集約とMaximum
グループ・ロールアップを指定します。 - 「パネル」タブで、このパネルの名前を
Total number of Application Instances
に変更します。 - 保存 をクリックして、このパネルの変更を保存します。
-
ibm_codeengine_jobruns
メトリックを使用して、Total number of Application revisions
数値パネルを変更し、ジョブ実行の数を表示するように照会を変更します。- パネルを編集するには、鉛筆アイコンをクリックします。
- 照会タブで、
ibm_codeengine_application_revision_count
メトリックをクリックして、メトリックを変更します。 Code Engineメトリックのリストを表示するには、ibm_codeengine_
と入力します。 この例では、ibm_codeengine_jobruns
メトリックを選択し、Maximum
時間集約とMaximum
グループ・ロールアップを指定します。 - 「パネル」タブで、このパネルの名前を
Total number of Job Runs
に変更します。 - 保存 をクリックして、このパネルの変更を保存します。
-
アクション・メニューを使用して、
Total number of Application routes
番号パネルを削除します。 -
ibm_codeengine_application_actual_instances
メトリックおよびibm_codeengine_jobruns
メトリックを使用して、Applications overview
タイム・チャート・パネルを変更し、アプリケーションおよびジョブ実行インスタンスに関するモニター情報を表示するように照会を変更します。- パネルを編集するには、鉛筆アイコンをクリックします。
- 「照会」タブで、
ibm_codeengine_application_actual_instances
メトリックを保持し、それらのメトリックのアクション・メニューを使用してメトメックの他の行を削除します。 - 「照会」タブで、
ibm_codeengine_application_actual_instances
メトリックを見つけ、アプリケーション・リビジョン情報を含むようにセグメンテーションを変更します。ibm_codeengine_application_name
をクリックし、ibm_codeengine_revision_name
を追加します。Apply to All Queries
の選択をクリアしたことを確認します。 - 「照会」タブで、照会の追加をクリックして、ジョブ実行の照会を追加します。 メトリック・フィールドに、Code Engineメトリックのリストを示す
ibm_codeengine_
を入力します。ibm_codeengine_jobruns
メトリックを選択し、Maximum
時間集約とMaximum
グループ・ロールアップを指定します。 このメトリックのibm_codeengine_jobrun_condition
セグメンテーションを指定します。 - このパネルの
ibm_codeengine_application_actual_instances
およびibm_codeengine_jobruns
メトリックのみを設定していることを確認してください。 - 「パネル」タブで、このパネルの名前を
Application and Job Run Instances
に変更します。 - 保存をクリックして、このパネルの変更を保存します。
-
このシナリオの前のステップで更新されたパネルを保持しますが、アクション・メニューを使用して他のパネルを削除します。 不要なパネルを削除した後、必要に応じて個々のパネルのサイズとレイアウトを調整できます。
ダッシュボードのレイアウトを変更する場合は、必ずレイアウトの保存をクリックして変更を保存してください。 ダッシュボードの変更を続行する前に、レイアウトの変更を保存するか、キャンセルしなければなりません。
シナリオ 1 を完了すると、カスタム・ダッシュボードにTotal number of Application Instances
、Total number of Job Runs
、およびApplication and Job Run Instances
の 3 つのパネルが組み込まれます。
シナリオ 2: Code Engineワークロードでの PromQL 照会の使用
シナリオ 1 で作成したカスタム・ダッシュボードから、IBM Cloud MonitoringのPrometheus照会言語 (PromQL) 照会機能を使用して、アプリケーションとジョブ実行のメトリックの数を 1 つのパネルに集約したいと仮定します。 このシナリオでは、PromQL を使用して、アプリケーション・インスタンスの数とジョブ実行の数を単一の数値パネルに追加します。
-
シナリオ 1 でカスタマイズしたカスタム・ダッシュボードを開きます。 カスタム・ダッシュボードは、ダッシュボードのナビゲーション・メニューダッシュボード-> マイ・ダッシュボードで使用できます。
-
Total number of Applications
の数値パネルを変更し、アプリケーション・インスタンスの数とジョブ実行の数を合計するように照会を変更します。- パネルを編集するには、鉛筆アイコンをクリックします。
- 「照会」タブで、
PromQL
をクリックして PromQL 照会を使用します。 - 「照会」タブで、照会の内容を
sum(max(ibm_codeengine_application_actual_instances) + max(ibm_codeengine_jobruns))
に置き換えます。number
を単位として使用するように オプション を更新します。 **「照会の実行 (Run query)」**をクリックします。 - 「パネル」タブで、このパネルの名前を
Total number of Application instances and Job Runs
に変更します。 - 保存 をクリックして、このパネルの変更を保存します。
-
「アクション」メニューを使用して
Total number of Job Runs
番号パネルを削除します。これは、前のステップでアプリケーションの総数とジョブの実行の両方を単一の番号パネルに集約したためです。 -
必要に応じて、個々のパネルのサイズとレイアウトを調整できます。
ダッシュボードのレイアウトを変更する場合は、必ずレイアウトの保存をクリックして変更を保存してください。 ダッシュボードのカスタマイズを続行する前に、レイアウトの変更を保存するか、キャンセルしなければなりません。
シナリオ 2 を完了すると、カスタム・ダッシュボードにTotal number of Application instances and Job Runs
とApplication and Job Run Instances
の 2 つのパネルが組み込まれます。