メインコンテンツまでスキップ

Insightsを始める

Insightsは、お客様のWorkspacesのすべてのプロジェクトのパフォーマンスを常に追跡します。すべてのプロジェクトの集計ビルドデータ、各プロジェクトの詳細なメトリクス、さらにダッシュボードを使用してメトリクスを自由に分類して表示することもできます。また、Insightsではボトルネックも確認できます。最も時間がかかる、または最もクレジットを消費するWorkflowsとテストを表示します。

WorkspaceのInsightsページにアクセスするには、次の手順に従います。

  1. BitriseアカウントにLog inします。
  2. 右上のアカウントセレクタードロップダウンメニューを開き、Workspaceを選択します。
  3. ヘッダーでInsightsをクリックします。これにより、選択したWorkspaceのOverviewページに移動します。

OverviewページClick to copy link​

Overviewでは、選択したWorkspaceの集計ビルドデータを確認できます。選択したタイムフレームをカバーするチャートの形式で、集計ビルドデータとプロジェクトレベルのビルドデータの両方を確認できます。

Insights_overview.gif

Workspacesはいつでも切り替えることができます。右上のアカウントセレクタードロップダウンメニューを開き、Workspaceを選択してください。

ビルドメトリクスへのアクセスClick to copy link​

Workspaceまたは特定のアプリの詳細なビルドメトリクスには、2つの方法でアクセスできます。左側でBuildsを選択するだけの方法と、WorkspaceのOverviewページから特定のメトリクスを選ぶ方法です。ここでは2つ目の方法について説明します。

  1. WorkspaceのOverviewページを開きます。

  2. 必要なメトリクスを見つけます。例えば、Build failure rateです。

  3. View detailsをクリックします。

    Workspaceに複数のプロジェクトがある場合、Detailsページでは、デフォルトでWorkspaceのすべてのプロジェクトの集計メトリクスが表示されます。

  4. 左端のドロップダウンメニューから、必要なプロジェクトを選択します。

  5. 必要に応じて、Add filterボタンを使用してフィルターを追加し、特定のデータを詳しく確認できます。フィルターの対象は次のとおりです。

    • Pipelines: プロジェクトの特定のPipelineで実行されたビルドのメトリクス。
    • ステージ: Pipelineの特定のステージで実行されたビルドのメトリクス。
    • Workflows: プロジェクトの特定のWorkflowで実行されたビルドのメトリクス。
    • ブランチ: 特定のブランチのビルドのメトリクス。
    • Machine types: 特定のマシンタイプで実行されたビルドのメトリクス。
    • Stacks: 特定のスタックで実行されたビルドのメトリクス。

    filtering_highlight.png

  6. 下にスクロールすると、個々のビルドと、実行時に使用したStepsを含むデータを確認できます。

利用可能なビルドメトリクスについては、Bitrise CIメトリクスをご覧ください。

アプリのテストメトリクスへのアクセスClick to copy link​

Insightsでは、個々のテストモジュールのレベルまで、テストメトリクスを追跡できます。これを行うには、結果をDeploy to Bitrise.io - Build Artifacts, Test Reports, and Pipeline intermediate filesStepにエクスポートするテストStepが必要です。次のStepsは、追加設定を必要とせずに自動的にこれを行います。

これらのStepsのいずれかを使用してテストを実行している場合は、Insightsでメトリクスを確認できます。

  1. Insightsを開きます。

  2. 左側でTestsを選択します。

  3. 左端のドロップダウンメニューから、必要なプロジェクトを選択します。

  4. 必要に応じて、フィルターを使用して特定のテストデータを詳しく確認できます。フィルターの対象は次のとおりです。

    • Test suite
    • Test cases
    • モジュール
    • ブランチ

    testing_metrics.png

  5. 下にスクロールすると、個々のテストケースを確認できます。

利用可能なテストメトリクスについては、Bitrise CIメトリクスをご覧ください。

ボトルネックClick to copy link​

Bottlenecksセクションでは、最も時間やクレジットを節約できる箇所を把握できます。どのWorkflowsやテストが最も時間がかかり、最もクレジットを消費しているかを表示します。

Bottlenecksページにアクセスするには、左側でBottlenecksを選択するだけです。ボトルネックは、すべてのメトリクスで使用する3つの基本カテゴリ(Builds、Tests、Credits)に分かれています。各カテゴリには3つのメトリクスがあります。

  • Failing Workflows/失敗したテスト: ビルドで使用される時間またはクレジットに最も大きな影響を与えるfailing Workflowsやテストケースです。
  • Build time/Run time: ビルド時間が増加しているWorkflows、または実行時間が増加しているテストケースです。
  • Usage/Flakiness: 最も多くのリソース(時間またはクレジット)を消費したWorkflows、またはフレーキーな実行が最も多いテストケースです。

特定のタイムフレームのデータの表示Click to copy link​

デフォルトでは、すべてのInsightsページで過去12週間分のメトリクスが週単位で表示されます。ページ右上のそれぞれのドロップダウンメニューを開き、必要なオプションを選択することで、単位とタイムフレームを変更できます。

builds_timeframe.png

DashboardsページClick to copy link​

InsightsのDashboardsページを使用すると、Workspaceのチャートを分類し、一か所でまとめて確認できます。

ビルド、テスト、Creditsタブのチャートを1つのダッシュボードにまとめることができ、ダッシュボードはいくつでも作成できます。

dashboards.png

新しいダッシュボードの作成Click to copy link​

新しいダッシュボードは、Dashboardsページから作成するか、Add to dashboardボタン(Add_To_dashboard.png)をクリックしてからCreate dashboardボタンをクリックすることで作成できます。このガイドでは前者の方法を中心に説明します。

  1. Insightsを開きます。

  2. 左側でDashboardsを選択します。

  3. Create dashboardをクリックしてCreate dashboardウィンドウを開きます。

    Create_dashboard.png

  4. Dashboard nameフィールドにダッシュボードの名前を入力し、必要に応じてDescriptionフィールドに説明を追加します。

  5. default viewの粒度とtime rangeを選択します。これらのオプションは後で変更することもできます。

  6. Createをクリックします。

ダッシュボードへのアクセスClick to copy link​

ダッシュボードにアクセスするには、次の手順に従います。

  1. Insightsを開きます。
  2. 左側でDashboardsを選択します。
  3. ダッシュボードの名前または矢印アイコン(「project_selector_arrow.png」)をクリックして、特定のダッシュボードを開きます。

ここから、以前にダッシュボードに追加したチャートを確認できます。詳細については、ダッシュボードへのチャートの追加をご覧ください。

ダッシュボードへのチャートの追加Click to copy link​

Builds、Tests、Creditsタブの任意のチャートをダッシュボードに追加できます。

  1. Insightsを開きます。
  2. 左側でBuilds、Tests、またはCreditsタブを選択します。
  3. ダッシュボードに追加したいメトリクスを検索します。
  4. その隣にあるAdd to dashboard( Add_To_dashboard.png )ボタンをクリックします。
  5. Chart nameフィールドに名前を入力します。
  6. ドロップダウンメニューを使用して、このチャートを配置したいダッシュボードを選択します。
  7. Addをクリックします。

以上です。これ以降、Dashboardページでチャートを確認できるようになります。

ダッシュボードからのチャートの削除

編集モードを使用して、ダッシュボードからチャートを削除できます。詳細については、ダッシュボードの編集をご覧ください。

ダッシュボードの編集Click to copy link​

ダッシュボードを作成したら、必要に応じて自由に編集できます。デフォルトのtime rangeを編集したり、不要になったチャートを削除したりできます。そのためには、Edit modeを使用する必要があります。

  1. Insightsを開きます。

  2. 左側でDashboardsを選択します。

  3. 編集したいダッシュボードにアクセスします。

  4. オプションメニュー(⋮)をクリックし、次にEdit modeをクリックします。

    Edit_mode.png

  5. 編集モードでは、Settingsボタンをクリックしてダッシュボードのgeneral settingsを変更できます。また、以前に追加したチャートの名前を変更したり、隣にあるアイコンを使用して削除したりすることもできます。

    Edit_mode_opened.png

  6. ダッシュボードの編集が完了したら、Saveをクリックします。

アラートの作成Click to copy link​

特定のしきい値に達したときにトリガーするように監視したいメトリクスのアラートを作成できます。その後、アラート通知をSlackチャンネル、メールアドレス、またはTeamsチャンネルにプッシュできます。

アラートについて詳しくは、Insightsでのアラートの設定をご覧ください。