インサイト スナップショットバッジ
インサイト スナップショットバッジの概要
インサイト スナップショットバッジでは、プロジェクトの README に埋め込まれている ステータスバッジ と同様に、プロジェクトのヘルスや使用状況のメトリクスを素早く確認することができます。
インサイト スナップショットバッジの最も一般的なユースケースは、メインブランチのデプロイワークフローの インサイト メトリクスの、プロジェクトの README での表示です。 しかし、このバッジは、プロジェクト内のすべてのブランチのすべてのワークフローのインサイトメトリクスを表示するようにも設定できます。 そうすることにより、例えば、スケジュール化したワークフロー、ビルドターゲットが異なるワークフロー、テスト用に使われるワークフローの追加バッジを作成することができます。
インサイト スナップショットバッジは、一般的にプロジェクトの README に配置されますが、 Web ドキュメントのどこにでも埋め込むことができます。 現在このバッジは、インサイトダッシュボードから下記の 3 つのメトリクスを表示します。
-
Throughput: 選択したワークフローの設定した時間枠における平均実行数
-
Duration: 任意のワークフローの選択した時間枠における 95 パーセンタイル実行時間。 95 パーセンタイルにより、一時的な急増の可能性を考慮して最後の 5% を除いた、ビルド終了までの最長時間を確認できます。
-
Success Rate: 選択したワークフローの設定した時間枠における成功ビルドの割合
インサイト スナップショットバッジの生成
インサイトスナップショットバッジのパブリックリポジトリ用のコードスニペットを生成するには、 CircleCI Web アプリを開き、プロジェクトを選択します。 Project Settings を開き、Insights Snapshot Badge のページに移動します。
Insights Snapshot Badge のページでは、プロジェクトのメトリクスを表示するブランチ、ワークフロー、時間枠、そしてコードスニペットの形式を選択することができます。
以下の形式のコードを生成できます。
-
画像 URL
-
Markdown
-
Textile
-
RDoc
-
AsciiDoc
-
reStructuredText
-
Pod
下記は、CircleCI ドキュメントのリポジトリ用に Markdown 形式で生成されたインサイト スナップショットバッジの例です。
[](https://app.circleci.com/insights/github/circleci/circleci-docs?branches=master&workflows=build-deploy&reporting-window=last-30-days&insights-snapshot=true)プライベートリポジトリ用のバッジの作成
プライベートプロジェクトのインサイト スナップショットバッジを作成するには、“Status” のスコープを持つ API トークンを作成し、そのトークンを画像のソース URL に含める必要があります。 同じプロジェクトにステータスバッジを生成したことがある場合は、インサイト スナップショットバッジに同じ API トークンを再利用することができます。
Insights Snapshot Badge ページで Add API Token をクリックすると、直接 API トークンを追加することができます。 これにより、"Status" のスコープを持つ API トークンと "insights-snapshot" ラベルが作成されます。 (プロジェクトの API Permissions でも新しいトークンが表示されます)。 コードスニペットは、API の作成後に表示されます。
プロジェクトのステータスバッジ用に既に作成したスコープが「Status」のAPIトークンを再利用したい場合は、上記の CircleCI ウェブアプリのバッジジェネレータの代わりに、以下のテンプレートのいずれかを使用することができます。
以下のテンプレートでは、< > の項目をご自身の詳細情報に置き換えてください。 一部のオプションは下表のとおりです。
| Item | オプション |
|---|---|
|
|
|
|
|
|
|
|