Skip to main content

Getting started with Insights

Abstract

The Insights Overview page offers both aggregated and app-level metrics to check the CI/CD health of your app. Compare values of the same point in time across charts and quickly assess whether there are any negative trends that need your immediate attention.

Insights constantly tracks the performance of all the apps of your Workspaces. You can get aggregated build data of all your apps, and you can also get to the detailed metrics of each app. Insights also allows you to view bottlenecks: it shows you the Workflows and tests that take the most time or cost you the highest amount of credits.

To get to your Workspace's Insights page:

  1. Log in to your Bitrise account.

  2. In the top right corner, open the account selector dropdown menu and select a Workspace.

  3. On the header, click Insights. This takes you to the Overview page of the selected Workspace.

The Overview page

On the Overview, you can see aggregated build data of the selected Workspace. You can see both aggregated build data and app-level build data in the form of charts that cover the selected timeframe.

insights-overview-gif.gif

You can switch between Workspaces at any time: in the top right corner, open the account selector dropdown menu and select a Workspace.

Accessing the build metrics

You can get to the detailed build metrics of your Workspace or a specific app in two ways: you can simply select Builds on the left, or you can choose a specific metric from the Overview page of the Workspace. We'll go through the second method:

  1. Open the Overview page of your Workspace.

  2. Find the metric you need. For example, Build failure rate.

  3. Click View details.

    If you have more than one app in the Workspace, on the Details page you will see the aggregated metrics for all apps of the Workspace by default.

  4. From the leftmost dropdown menu, select the app you need.

  5. Optionally, you can dig deeper by using filters to view specific data. You can filter for:

    • Workflows: metrics of builds that ran with a specific Workflow of the app.

    • Branches: metrics of builds of a specific branch.

    • Machine types: metrics of builds that ran on a specific machine type.

    • Stacks: metrics of builds that ran on a specific stack.

    filters.png
  6. Scroll down to see individual builds, their data, including the Steps they ran with.

For the available build metrics, check out Available metrics in Insights.

Accessing the testing metrics of an app

Insights allows you to keep track of testing metrics, right down to the level of individual testing modules. To do this, you need a testing Step that exports its results to the Deploy to Bitrise.io Step. The following Steps do this automatically, without any need for additional configuration:

  • Xcode Test for iOS

  • Android Unit Test

  • iOS Device Testing

  • Virtual Device Testing for Android

  • Flutter Test

If you use any of these Steps to run your tests, you can check your metrics in Insights:

  1. Open Insights.

  2. On the left, select Tests.

  3. From the leftmost dropdown menu, select the app you need.

  4. Optionally, you can dig deeper by using filters to view specific testing data. You can filter for:

    • Test suites

    • Test cases

    • Modules

    • Branches

    filters.png
  5. Scroll down to see the individual test cases.

For the available test metrics, check out Available metrics in Insights.

Bottlenecks

The Bottlenecks section helps you understand where you can save the most time or credits. We show you which of your Workflows and tests take the longest time and cost the highest amount of credits.

To access the Bottlenecks page, simply select Bottlenecks on the left. The bottlenecks are divided into the three basic categories we use for all metrics: Builds, Tests, and Credits. Each category has three metrics:

  • Failing Workflows/Failing tests: these are the failing Workflows or test cases that have the highest impact on the time or credits spent on your builds.

  • Build time/Run time: Workflows with increasing build times, or test cases with increasing run times.

  • Usage/Flakiness: Workflows that consumed the highest amount of resources (either time or credits), or test cases with the most flaky runs.

Viewing data from a specific timeframe

By default, all Insights pages display your metrics on a weekly basis from the last 12 weeks. Modify the basis and timeframe by opening the respective dropdown menu in the top right of the page, and selecting the options you need.

Selecting a timeframe in Build Insights