Using Insights

Overview

The CircleCI Insights dashboard provides an overview of the health and usage of your repository build processes, allowing users to make better engineering decisions. Insights provides time-series data overviews of credit usage, success rates, pipeline duration, and other pertinent information.

This document describes how to access and use the Insights dashboard on CircleCI Cloud and Server.

Usage (CircleCI Cloud)

Insights across your organization can be accessed from the sidebar of the CircleCI web application.

To access a specific project’s insights, view a pipeline’s workflow and click the Insights button. Alternatively, you may access the Insights page by clicking on the actions button while viewing the pipelines dashboard.

Workflow Overview

The Insights dashboard provides workflow details plotted over the last 90 days. Please note that the data is not real time and there may be up to a 24 hour delay. You may also filter by different workflows at the top of the page. The following data is charted under the workflow overview:

  • All workflow runs
  • Workflow success rate
  • Workflow duration
  • Workflow credit usage*

Job Overview

Switch to the Job tab to view cumulative time-series data on a per-job basis:

  • Total credits used*
  • Duration (the 95th percentile)
  • Total runs
  • Success rate

* The Insights dashboard is not a real time financial reporting tool and should not be used for credit reporting. The most up to date credit information can be found in your organization’s Plan Overview.


CircleCI Server Insights

Overview

Click the Insights menu item in the CircleCI app to view a dashboard showing the health of all repositories you are following. Median build time, median queue time, last build time, success rate, and parallelism appear for your default branch. Note: If you have configured Workflows, graphs display all of the jobs that are being executed for your default branch.

header

The image illustrates the following data about your builds:

  • Status of all your repos building on CircleCI in real time
  • Median queue time
  • Median build time
  • Number of branches
  • Last build

Project Insights

Click the Insights icon on the main navigation, then click your repo name to access per-project insights.

The per-project insights page gives you access to the build status and build performance graphs for a selected branch.

header

  • Build Status: The Insights dashboard shows the last 50 builds for your default branch. Click a branch in the top right corner to access over 100 build/job statuses for the selected branch.

  • Build Performance: The Build Performance graph aggregates your build/job data for a particular day and plots the median for that day going back as far as 90 days. Monitor the performance of your repo by clicking a particular branch.

Sumo Logic Integration

Sumo Logic users may track and visualize analytical data across all of their jobs on CircleCI. To do so, use the Sumo Logic Orb and Sumo Logic app integration from the Sumo Logic partner integrations site.

The CircleCI Dashboard for Sumo Logic

header

Included panels:

  • Total Job
  • Total Successful Jobs
  • Total Failed Jobs
  • Job Outcome
  • Average Runtime in Seconds (by Job)
  • Jobs By Projects
  • Recent Jobs (latest 10)
  • Top 10 Slowest Failed Jobs In Seconds
  • Top 10 Slowest Successful Jobs In Seconds

Install the CircleCI dashboard by using the App Catalog from the dashboard home page.

header

This dashboard receives data through the CircleCI Sumo Logic orb which must be included in your projects to be tracked.

The Sumo Logic Orb

Find the latest version of the Sumo Logic orb on the Orb Registry.

1. Import the Sumo Logic orb.

Add the Sumo Logic orb to your project by including the top-level orbs key and import circleci/sumologic@x.y.z as follows, replacing x.y.z with the latest version number at the link above.

orbs:
  sumologic: circleci/sumologic@x.y.z

2. Add Workflow-Collector to Workflow.

The workflow-collector job runs concurrently along side your workflow and sends analytics to Sumo Logic until all of the jobs in your workflow have completed.

version: 2.1
workflows:
  build-test-and-deploy:
    jobs:
      - sumologic/workflow-collector # add this job to track workflow.
      - build
      - test:
          requires:
            - build
      - deploy:
          requires:
            - test

3. Create two source collectors.

You will need to create two source collectors on Sumo Logic which will return an HTTPS URL. Your job data will be sent to this HTTPS URL.

You will need to create one called circleci/job-collector and another called circleci/workflow-collector.

To create the two source collectors:

  1. From the dashboard select the Setup Wizard.
  2. Select Set Up Streaming Data.
  3. Scroll to the bottom and select All Other Sources.
  4. Select HTTPS Source
  5. For the Source Category enter one of the two mentioned above.
  6. Save the resulting URL.

4. Add environment variables.

For each of the URLs produce in the previous step, create the corresponding environment variable.

Env vars:

  • JOB_HTTP_SOURCE
  • WORKFLOW_HTTP_SOURCE

How to add an environment variable to your project.

This will link the orb with your Sumo Logic dashboard.

Your Sumo Logic dashboard will now begin to populate with data as each job runs on CircleCI.

See Also

Refer to the Orbs Introduction document to learn more about using and authoring orbs.

See Also

Refer to the Collecting Test Metadata document for instructions to configure insights into your most failed tests.