こんにちは、テクマトリックスの米田です。
世界中で広く利用されているOSSのJenkinsは、CI/CDツールとして現在も活発なコミュニティにより日々アップデートされています。有償版のJenkinsを扱っているCloudBeesは、2024年9月17日に行われたDevOps World 2024で「Pipeline Graph View」プラグインをJenkinsの新たなUIとして紹介しました。今回はこのPipeline Graph Viewプラグインを実際に使用し、利用方法や特徴などをご紹介します。
（2024年11月5日現在の情報になります）

Pipeline Graph Viewプラグインとは

JenkinsのPipeline Graph Viewプラグイン（以下 Pipeline Graph View）は、Blue Oceanプラグイン（以下Blue Ocean）の長所であるパイプラインの視覚的な表示機能をJenkinsのUIに組み込んだプラグインです。パイプラインの実行後、その結果や構造を視覚的に理解することができます。Pipeline Graph Viewは、2024年9月17日に行われたCloudBees主催のDevOps World 2024でトピックの一つに挙げられました。また、2024年10月31日時点ではJenkinsインストール時の推奨プラグインに含まれています。

Pipeline Graph Viewプラグインの利用

利用したバージョン

今回利用したJenkinsとPipeline Graph Viewのバージョンは以下の通りです。

プラグインのインストール

プラグインのインストール方法について簡単に説明します。

• 既にJenkinsをインストールしている場合
  • [Jenkinsの管理] > [プラグインの管理] > [利用可能タブ]で、Pipeline Graph Viewプラグインを検索します。Pipeline Graph View Pluginをインストールすることで、実行に必要な他のプラグインも同時にインストールされます。

• 新規にJenkinsを構築する場合
  • 推奨プラグインに含まれているので、「Install suggested plugins」を選択することでインストールされます。

外観設定

Pipeline Graph Viewをインストールした後、[Jenkinsの管理] > [Appearence] > [Pipeline Graph View]から、視覚化されたパイプライン構造をジョブページやビルドページに表示するかどうかを選択できます。今回は両方に表示させるため、両方にチェックを入れて保存します。

パイプラインの作成

Pipeline Graph Viewには、Blue Oceanのようなエディター機能はありません。実行するパイプラインの内容は、別途Jenkinsfileに記述する必要があります。

実行結果の確認

● ジョブページ
これまではPipeline Stage Viewプラグイン（以下Pipeline Stage View）を使用したマトリクスを確認して、パイプラインの結果や構造を確認することが多かったかと思います。Pipeline Stage Viewを用いた場合はジョブページにアクセスすると、以下のように実行結果が出力されます。

Pipeline Graph Viewを用いた場合はジョブページに以下のように出力されます。各ビルドごとに実行されたパイプラインの構造や各ステージの結果を確認することができます。

● ビルドページ
ジョブページ左下にはこれまで実行したパイプラインがリストされており、ビルドナンバーをクリックするとビルドページに遷移できます。ビルドぺージの上部には、実行したパイプラインの詳細な構造が表示されており、その他の情報も確認できます。左側のサイドメニューには、Pipeline Graph Viewのインストールにより、「Pipeline Overview」と「Pipeline Console」が表示されます。

● Pipeline Overview
各パイプラインの詳細な実行結果を確認するには、Pipeline Overview画面に移動します。ここでは、選択したパイプラインの構造や実行結果、Gitのコミット番号やパイプラインの実行時間などを確認することができます。右上にはパイプラインを再度実行するRebuildボタンと、Pipeline Console画面に移動するためのConsoleボタンもあります。

● Pipeline Console
Pipeline Overview画面で、各ステージまたは右上のConsoleボタンをクリックすることで、パイプラインの各ステージのコンソールの詳細を確認することができます。各ステージの名前、実行時間や結果、および出力されるコンソールなどを確認することができます。左上のビルドナンバーの左右にある矢印から、前後のビルドナンバーのコンソールを確認することもできます。右上にはパイプラインを再度実行するためのRebuildボタンと、Pipeline Overview画面に移動するためのOverviewボタンなどもあります。

Pipeline Graph Viewプラグインを利用した感想

Pipeline Graph Viewを用いてパイプラインの実行結果を確認しましたが、個人的に感じた良い点と気になる点を記載します。

良い点

• モダンなUI
  Pipeline Graph Viewを使用して表示されるパイプラインの構造やコンソールは、Blue OceanやPipeline Stage Viewと比較するとよりモダンで、感覚的に分かりやすいと感じました。
• Jenkins Classic WebUIでのパイプライン構造の視覚化
  ビルドページやPipeline Overviewでは、パイプラインの構造を、並列ステージも含めて視覚的に理解することができます。Pipeline Stage Viewを使用したマトリクスでは、並列ステージの構成までは判断することが出来ませんでした。
  また、Blue Oceanを使用する場合は、JenkinsのClassic Web UIからBlue Oceanのパイプラインエディター画面に移動する必要がありました。一方、Pipeline Stage ViewではJenkinsのClassic Web UIでパイプラインの構造を確認できるため、Web上でのページ移動が減りました。
• パイプライン構造変更前後の一括確認
  Pipeline Stage Viewを使用してパイプラインの実行結果をマトリクス形式で確認する場合、パイプラインのステージの構成を変更すると同じマトリクスで結果を確認できなくなったり、並列実行されたステージの構成を確認できませんでした。Pipeline Graph Viewでは、過去に実行したパイプラインとステージの構成を変更しても一度に確認できます。

気になる点

• 各パイプラインの実行日時が分からない
  ジョブページでパイプラインの実行結果を確認するとき、Pipeline Stage Viewを使用した実行結果のマトリクスにはパイプラインの実行日時が記載されていますが、Pipeline Graph Viewを使用したパイプラインの一覧には実行日時が記載されていません。
  現時点では、各ビルドナンバーに対応するビルドページに移動することでパイプラインの実行日時を確認できますが、この問題はPipeline Graph Viewのissueでも取り上げられていたため、Pipeline Graph Viewがアップデートされ、機能が追加されるのを期待します。

• inputステップの後続処理の選択ができない
  Jenkinsのパイプラインでは、後続のステージの実行を対話的に選択できるinputステップという機能があります。Blue OceanやPipeline Stage Viewのマトリクスを用いた場合、該当のステージのステップを実行するかどうかを選択することができます。
  しかしPipeline Graph ViewではPipeline Consoleに表示されるinputステップの後続処理のリンクを選択しても、パイプラインの実行は進みませんでした。
  この問題は、Pipeline Graph Viewに関連したissueが報告されていました。
  現時点の回避策は、実行しているパイプラインのClassic Consoleから後続処理を選択することが挙げられます。

まとめ

実際にPipeline Graph Viewを使用してみると、モダンな分かりやすいUI上で実行したパイプラインの結果が視覚的に分かる便利なプラグインだと感じました。一方でいくつか気になる点もあり、「惜しい」と思ったのが正直な感想です。Pipeline Graph Viewの開発プロジェクトは活発に活動しており、Jenkinsインストール時の推奨プラグインにも含まれていることから、今後さらなるアップデートが期待できるので、注目していきたいと思います。
もしご興味あれば、Pipeline Graph Viewの利用やコミュニティ活動に参加してみてください。