コンテンツにスキップ

CI エクスプローラー


Guance は、Gitlab/Jenkins に組み込まれた CI のプロセスと結果の可視化をサポートしています。Guance の CI 可視化機能を使用すると、Gitlab/Jenkins の CI 結果を直接確認し、CI のパフォーマンス、実行時間の傾向、失敗原因をリアルタイムに把握できます。また、CI フレームグラフを使用して、CI プロセス中の Pipeline 全体の健全性をリアルタイムに確認し、コード更新の保証に役立てることができます。

データの検索と分析

CI のプロセスと結果のデータが Guance のワークスペースに送信されると、CI エクスプローラーで時間範囲の選択、キーワード検索、フィルターなどの方法により、Pipeline と Job の成功率、失敗原因、具体的な失敗箇所などを検索・分析できます。

リスト上部の分布図は、デフォルトで現在の Pipeline または Job のステータスで集計されます。ステータス分布図の設定 を使用して件数集計に切り替え、各時間帯のレコード総数を確認することもできます。

時間ウィジェット

CI エクスプローラーはデフォルトで直近 15 分間のデータを表示します。右上隅の「時間ウィジェット」を使用して、データを表示する時間範囲を選択できます。詳細はドキュメント 時間ウィジェットについて を参照してください。

検索とフィルター

CI エクスプローラーの検索バーでは、キーワード検索、ワイルドカード検索、関連検索、JSON 検索など、複数の検索方法に対応しています。また、タグ/属性 による値のフィルターにも対応しており、正方向フィルター、逆方向フィルター、あいまい一致、逆方向あいまい一致、存在、非存在など、複数のフィルター方法があります。検索とフィルターの詳細はドキュメント エクスプローラーの検索とフィルター を参照してください。

分析モード

CI エクスプローラーの分析バーでは、1〜3 個のタグに基づく多次元の分析集計が可能で、さまざまなディメンションと時間におけるデータの分布特性と傾向を把握できます。Guance は、時系列グラフ、トップリスト、円グラフ、矩形ツリーマップなど、複数のデータチャート分析に対応しています。詳細はドキュメント エクスプローラーの分析モード を参照してください。

クイックフィルター

CI エクスプローラーのクイックフィルターでは、「クイックフィルター」を編集して新しいフィルターフィールドを追加できます。追加後、そのフィールドの値を選択してクイックフィルターを実行できます。

注意:

  • クイックフィルターの「継続時間」のデフォルトのプログレスバーの最小値と最大値は、リンクデータリスト内の最小および最大の継続時間です。
  • プログレスバーをドラッグして最大値/最小値を調整できます。入力ボックスの値も同期して変化します。
  • 最大値/最小値を手動で入力できます。「Enter キー」または「入力ボックスの外側をクリック」でフィルター検索を実行します。
  • 入力形式が正しくない場合は入力ボックスが赤くなり、検索は実行されません。正しい形式:純粋な「数字」または「数字+ns/μs/ms/s/min」です。
  • 単位を入力せずに検索した場合、デフォルトで入力した数字の後ろに「s」が追加されてフィルター検索が実行されます。
  • 単位を手動で入力した場合は、そのまま検索が実行されます。

クイックフィルターの詳細はドキュメント クイックフィルター を参照してください。

表示列のカスタマイズ

エクスプローラーのリストでは、「表示列」を使用して表示列の追加、編集、削除、ドラッグをカスタマイズできます。マウスをエクスプローラーの表示列に合わせて「設定」ボタンをクリックすると、表示列に対して昇順、降順、列を左へ移動、列を右へ移動、列を左に追加、列を右に追加、列を置換、クイックフィルターに追加、グループに追加、列を削除などの操作ができます。表示列のカスタマイズの詳細はドキュメント 表示列について を参照してください。

データエクスポート

エクスプローラーのリストでは、必要なデータをフィルターで絞り込んでからエクスポートし、表示や分析を行うことができます。「設定」の小さいアイコンをクリックして、CSV ファイル、ダッシュボード、ノートにエクスポートできます。

Gitlab

Pipeline エクスプローラー

エクスプローラーの左上隅で「Gitlab Pipeline」エクスプローラーに切り替えると、CI Pipeline のプロセスを検索・分析できます。対象には、Pipeline ID、名前、継続時間、コミット内容、コミット時間などが含まれます。

Pipeline 詳細ページ

Pipeline リストで確認したいデータをクリックすると、スライドアウトした詳細ページに Pipeline と Job の詳細が表示されます。属性、フレームグラフ、Job リスト、コンテンツ詳細、関連ログなどが含まれます。

マウスで属性フィールドをクリックすると、「フィールド値をフィルター」「フィールド値を逆フィルター」「表示列に追加」「コピー」によるクイックフィルター表示が可能です。

  • 「フィールド値をフィルター」:そのフィールドをエクスプローラーに追加し、そのフィールドに関連するすべてのデータを表示します。
  • 「フィールド値を逆フィルター」:そのフィールドをエクスプローラーに追加し、そのフィールド以外のデータを表示します。
  • 「表示列に追加」:そのフィールドをエクスプローラーのリストに追加して表示します。
  • 「コピー」:そのフィールドをクリップボードにコピーします。

フレームグラフ

フレームグラフでは、CI プロセス中の Pipeline 全体の各 Job の流れと実行時間を明確に確認できます。フレームグラフの右側では、対応するサービスリストと実行時間の割合を確認できます。フレームグラフの pipeline と job をクリックすると、「詳細」で対応する Json コンテンツを確認できます。

フレームグラフの説明

CI 可視化では、主に CI プロセス中の Pipeline と Job のデータを収集します。Pipeline のプロセス全体は Build、Test、Deploy の 3 つのステージに分かれており、各ステージには異なるタスク(Job)があります。

  • 各ステージのタスクがすべて正常に完了すると、Pipeline は正常に実行完了となります。フレームグラフには Pipeline 全体の実行時間と各 Job の実行時間が表示されます。
  • 最初のステージ Build のタスクの実行中にエラーが発生した場合は、タスクの失敗とエラーの原因が通知されます。

理解を助けるため、下図に Gitlab CI の Pipeline プロセスの例を示します。上記のフレームグラフと照らし合わせることで、各 Job の実行時間と Pipeline 全体の実行時間を明確に確認できます。

Job リスト

Pipeline 全体に含まれるすべてのステージとその Job 数を表示します。表示内容には、「リソース名」、「Job 数」、「実行時間」、「実行時間の割合」が含まれます。任意の Job をクリックすると、「詳細」で対応する Json コンテンツを確認できます。エラーがある場合は、Job の前にエラー通知が表示されます。

Job エクスプローラー

エクスプローラーの左上隅で「Gitlab Job」に切り替えると、CI Pipeline の Job プロセスを検索・分析できます。Pipeline ID、Job 名、継続時間、コミット内容、コミット時間などが含まれます。

Job 詳細ページ

Job リストで確認したいデータをクリックすると、スライドアウトした詳細ページに Pipeline と Job の詳細が表示されます。属性、フレームグラフ、Job リスト、コンテンツ詳細、関連ログなどが含まれます。

Jenkins

Pipeline エクスプローラー

エクスプローラーの左上隅で「Jenkins Pipeline」エクスプローラーに切り替えると、CI Pipeline のプロセスを検索・分析できます。Pipeline ID、名前、継続時間、コミット内容、コミット時間などが含まれます。

Pipeline 詳細ページ

Pipeline リストで確認したいデータをクリックすると、スライドアウトした詳細ページに Pipeline と Job の詳細が表示されます。属性、フレームグラフ、Job リスト、コンテンツ詳細、関連ログなどが含まれます。

Job エクスプローラー

左上隅のデータ型フィルターバーで「jenkins_job」エクスプローラーに切り替えると、CI Pipeline の Job プロセスを検索・分析できます。Pipeline ID、Job 名、継続時間、コミット内容、コミット時間などが含まれます。

Job 詳細ページ

Job リストで確認したいデータをクリックすると、スライドアウトした詳細ページに Pipeline と Job の詳細が表示されます。属性、フレームグラフ、Job リスト、コンテンツ詳細、関連ログなどが含まれます。

フィードバック

このページは役に立ちましたか?