Documentation structure for LLMs (llms.txt)
CircleCI Logo

Using Insights

4 days ago
Cloud Server v4+

The CircleCI Insights dashboard provides an overview of the health and usage of your projects' build processes. Insights include time-series and aggregated data on credit usage, success rates, and pipeline duration. This page describes how to access and use the Insights dashboard on CircleCI Cloud and Server.

Usage

You can access the Insights dashboard from several places in the CircleCI web app, as follows:

  • Access from the sidebar

  • Access from a workflow

  • Access from a pipeline

Select Insights from the sidebar to access the Insights dashboard. Use the project dropdown filter menu to restrict the data to a specific project, or select a project by name from the list. Once you have a project selected to you drill down to view workflow, job, and test Insights.

Access insights from the CircleCI web app sidebar
Figure 1. Access insights from the CircleCI web app sidebar

Accessing Insights from a specific workflow or the pipelines dashboard opens the Insights dashboard at the workflow Insights level. From here you can use the breadcrumbs and job/test tabs to view Insights at other levels or get back to the Insights dashboard to select a different project.

Access insights from a workflow in the CircleCI web app
Figure 2. Access insights from a workflow in the CircleCI web app

Accessing Insights from a specific workflow or the pipelines dashboard opens the Insights dashboard at the workflow Insights level. From here you can use the breadcrumbs and job/test tabs to view Insights at other levels or get back to the Insights dashboard to select a different project.

Access insights from a pipeline in the CircleCI web app
Figure 3. Access insights from a pipeline in the CircleCI web app

Workflow Insights

The Insights workflow overview provides metrics plotted over time for all branches, or a select branch, of a particular project workflow. The following data is charted under the workflow overview:

  • Status (success versus failed) of up to 100 most recent workflow runs.

  • Workflow success rate.

  • Workflow duration (50th versus 95th percentile).

  • Workflow credit usage.

Job Insights

Select the Jobs tab next to Overview to view the following cumulative data on a per-job basis:

  • Total credits used

  • Duration (95th percentile)

  • Total runs

  • Success rate

Test Insights

For a guide to using test Insights, see the Test Insights page. Test Insights are available for github and bitbucket type organizations. For a guide to organization type, see the Users, Organizations, and Integrations Guide.

Insights vs Plan overview

Insights is not a financial reporting tool, and must not be used for precise credit reporting. Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI web app. The underlying data for Insights does not have the same data-accuracy guarantees as for billing information. This may lead to discrepancies between credits reported from Insights, and the billing information in the Plan Overview page. For precise credit reporting, always use the Plan Overview page in the CircleCI web app.

Data is not real-time and there may be up to a 24-hour delay.

See also

Refer to the Collect Test Data document for guidance on configuring Insights into your most consistently failing tests.

See the Insights API reference.