著者: Samantha Frost
パイプラインは開発プロセスの重要なコンポーネントですが、複雑なパイプラインをトラブルシューティングするのは、とくに大きな企業では、時間がかかる面倒な作業になる場合もあります。
そんなとき、パイプラインを簡単かつ効率的にトラブルシューティングする手段を提供するCloudBees Pipeline Explorerが役に立ちます。
従来のトラブルシューティング手段の課題
Jenkins®でパイプラインをデバッグするための既存の方法も、シンプルなパイプラインでは役に立ちますが、パイプラインが複雑になり、ログファイルが大きくなるにつれて、エンタープライズCI環境の厳しい要求に対処しきれなくなります。エンタープライズ規模の要求をサポートする必要があるJenkinsユーザーと話をしたとき、既存のソリューションの問題として挙げられるのは、次のような点です。
- 視覚的スケーラビリティの問題: 複雑なパイプラインを理解するのは大変で、とくに並行するブランチが相互に関連している場合、共同でデバッグするためにエラーの場所を特定し、共有するのが難しくなります。
- 固有の検索およびコンテキスト切り替え機能がない: そのため、Web ブラウザーに備わった Ctrl + F による検索に頼るしかありません。既存のログ参照ソリューションで調査を行う場合によくある流れは、どこから調査を始めるかの見当をつけ、ダウンロードして Ctrl + F を利用する、というものです。
- パフォーマンス: 20MBのログをロードした後、スクロールする速度が速すぎると、ブラウザーに負荷がかかり、テキストが消えてしまいます。UIの更新が遅いからです。コンソールログのロードにも時間がかかる場合があります。規模が大きくなり始めると、ログファイルは大きくなり、UIの反応が遅くなります。
既存のソリューションでも、パイプラインがシンプルでログファイルが小さければ、問題なくログを確認できます。しかし、ログファイルが大きくなる複雑なパイプラインでは、規模に応じたデバッグを可能にする高速で高性能なエンタープライズソリューションが必要です。
CloudBees Pipeline Explorerの紹介
上記の課題を克服するためにCloudBeesが開発したCloudBees Pipeline Explorerは、ログ参照のエクスペリエンスを向上させ、複雑なパイプラインのトラブルシューティングを容易にします。 CloudBees Pipeline Explorerの開発にあたっては、もっと能率的なパイプラインのデバッグ方法が欲しいという、当社とその顧客の要望がヒントになりました。私たちは、トラブルシューティングを容易にし、複雑なパイプラインのデバッグに取り組む際の負担を軽減したいと考えました。新しいCloudBees Pipeline Explorerを使用すると、以下を実現できます。
- 共同でのデバッグ: チーム間のコミュニケーションをサポートするコントロールおよび機能を使用してすばやく簡単にコラボレーションできます。フィルター、行番号、行の特定のコンテンツをコピーし、コンテキストを維持できます。
- 高い応答パフォーマンス: 何万行ものログをジャンプする場合も応答がすばやく、ログを読み込んだ後にUIが更新されるまで待つ必要がありません。
- 直感的なレイアウト: 行番号、タイムスタンプの表示、タイムスタンプの表示形式などをカスタマイズできるモダンな UI を使用し、並行するブランチ間を簡単に視覚的に移動できます。
- ツリービューおよびフィルター: パイプライン全体の概要を参照できるとともに、ステージをフィルタリングすることもできるため、複雑なパイプラインを理解するのが容易になります。フィルターによって特定のブランチだけを表示しながら行番号を維持できるため、ログ内でブランチのコンテキストを維持できます。
- Issue Explorer: 検出された問題のリストから問題の場所にジャンプできます。
- 独自の検索機能: どんなサイズのログもすばやく検索でき、外部ツールを使う必要がありません。
- CloudBees Pipeline ExplorerはCloudBees Assurance Program (CAP)に含まれており、CloudBeesによって直接サポートされます。
最適化されたトラブルシューティングへようこそ
Jenkinsを使い始めたばかりのユーザーにとっても、長年使いこんでいる玄人にとっても、CloudBees Pipeline Explorerは一見の価値があります。CIパイプラインのエラーを見つけて理解するためのもっとよい方法を探している、あるいはトラブルシューティングタスクのパフォーマンスを上げる必要があるパイプライン保守担当者や管理者にとって、CloudBees Pipeline Explorerは待望のソリューションです。
参考リソース
（この記事は、CloudBees社 Blog 「Optimizing Pipeline Troubleshooting with CloudBees Pipeline Explorer」2023年9月14日の翻訳です。）