本日、CircleCI’s API v2 で新しいインサイトエンドポイントを安定してご利用いただけるようになったことを発表いたします。CircleCI API の最新バージョンは、エンジニアリングチームが求めるすべての柔軟性とインテリジェンスを提供できるようになり、CircleCI をこれまで以上に活用いただけるようになりました。パイプラインを中心とするアプローチによって、テストスイートを効率的に実施できるようになる一方で、CircleCI のインサイトエンドポイントによって、ワークフローとクレジット消費に関する重要データを利用できるようになります。
このブログでは、本番環境で安定して使用できるようになったインサイトエンドポイントについて概説します。
データが多いほど確度の高い決定が可能となる
インサイトエンドポイントは、これまで数か月にわたってプレビューが実施されてきました。このエンドポイントによってユーザーは以下が可能になります。
- ステータスの追跡 — どのジョブが失敗しているか、どのワークフローに「Flaky Tes」があるかを確認し、パイプラインを改善する取り組みに優先順位を付けることができます。
- 実行時間の監視 — どのワークフローまたはジョブが最も時間がかかっているかを調査し、キャッシュ、並列化、およびCircleCIの新しいイメージが処理の高速化に役立つかどうかを特定します。
- クレジット消費の最適化 — ジョブやワークフローごとのクレジット支出に関するインサイトを使用して、CircleCI の使用を最適化します。毎月の消費量を予想して計画できます。
4 つの新しいエンドポイント
インサイトエンドポイントを使用すると、ユーザーは、ワークフローレベルまたはジョブレベルでクレジット消費および実行期間について集計された履歴データを取得し、自社独自のダッシュボードを構築できます。エンドポイントは現在、プロジェクトおよびブランチ内の特定のワークフローのデータを返します。
ジョブおよびワークフローレベルでの集計データの表示
GET https://circleci.com/api/v2/insights/{project-slug}/workflows
GET https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}/jobs
指定したブランチのプロジェクトジョブとワークフローに関する集計データを取得します。ペイロードには次のフィールドが含まれます。
- 名前
- 集計期間の開始日時（UTC）
- 集計期間の終了日時（UTC）
- 成功した実行
- 失敗した実行
- 合計実行数
- 成功率
- スループット（1 日あたりの平均実行数）
- 使用されたクレジットの合計
- 実行時間統計：最大、最小、平均、中央値、p95、標準偏差（すべて秒単位）
ジョブとワークフローの実行データの表示
GET https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}
GET https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}/jobs/{job-name}
指定したブランチの名前付きプロジェクトワークフローにおける直近の 250 回の実行（または過去 90 日以内の実行のいずれか新しい方）を取得します。ペイロードには次のフィールドが含まれます。
- ID
- ステータス
- 使用したクレジット
- 実行時間（秒）
- 作成時間（UTC）
- 停止時間（UTC）
詳細については、CircleCI のドキュメントを参照してください。
有用なメトリクスによるソフトウェアデリバリの向上
エンジニアリングのパフォーマンスを向上することは、多くの組織にとって最優先事項であり、成功を収めたチームは継続的インテグレーションこそがこの結果を出すための鍵であることを理解しています。CircleCI は、その製品の特性から、多くの組織がパフォーマンスを向上してきた進化の過程を直接確認してきました。CircleCI では、これらの調査結果をレポート『データで見る CI（継続的インテグレーション）を活用しているチームの利点』にまとめました。
これらの結果は、優れたパフォーマンスを達成しているユーザーが、他のソリューションと比較して特に CI を活用していることを示しています。CircleCI は、DevOps ジャーニーをチームが推進するために利用できる優れたツールとインテリジェンスを今後も提供していきます。
これらのインサイトエンドポイントを活用することで、エンジニアリングチームは、ワークフローがより長期間にわたってどのように実行されているかを示す重要な情報を利用できるようになり、成功/失敗率、スループット、平均復旧時間、および実行時間に関するメトリクスを追跡できるようになります。同様に、ワークフローの実行データを使用して、ユーザーは特定のワークフローで使用された実行時間とクレジットを追跡できます。最後に、集約されたジョブ情報を利用して、特定のワークフローのジョブがこれまでよりも長期間にわたってどのように実行されているかその概要を確認できるようになり、成功率/失敗率およびスループットを測定する機能が強化されます。
皆様がこれらのデータをどのように活用されるのかを今から楽しみにしています。また、CircleCI のユーザーがインテリジェンスをさらに強化できることを期待しています。
