Sleuth Documentation
HomeBlogSupportSign up
  • Getting started
  • Navigating Sleuth
  • DORA metrics
    • Deploy frequency
    • Change lead time
    • Change failure rate
    • MTTR
    • Interpreting Metrics in Sleuth
  • Deployment tracking
    • Organization
      • Labels
      • Trends
      • Compare
      • Search
      • Status
    • Projects
      • Issue trackers
    • Environments
    • Code deployments
      • Creating a deployment
      • How to register a deploy
      • Rollbacks
      • Automatic tagging
      • Deployment locking
      • Environment drift
      • Move code deployments
      • Search everything
    • Feature flags
    • Manual changes
    • Deploys
    • Teams
  • Work in Progress
  • Goals
  • Sleuth Automations
    • Automations Marketplace
      • Installing Automations
        • Installing PR "Update" Automations
      • Editing and uninstalling Automations
      • Smart suggestions
      • Understanding efficacy
    • Custom Automations
      • Automations Cookbook
      • Webhook Actions
      • Trigger Build Actions
        • Bitbucket Pipelines
        • CircleCI
        • Github Actions
        • Jenkins
  • Slack & Email Notifications
  • Auto-verify deploys
    • Anomaly detection
    • Error impact
    • Metric impact
  • Ignoring pull requests
  • Slack mission control
    • Approvals
    • Project notifications
    • Personal notifications
    • Search Sleuth in Slack
    • Project/Deployment history
    • Developer standup
  • Sleuth API
    • Deploy Registration
    • Deploy import
    • Manual Change
    • Custom Incident Impact Registration
    • Custom Metric Impact Registration
    • Deprecation information
    • GraphQL Queries
    • GraphQL Mutations
    • Query batching
  • Integrations
    • About Integrations...
    • Code integrations (read-only)
      • Azure DevOps
      • Bitbucket
      • GitHub
      • GitLab
      • Custom Git
      • Terraform Cloud
    • Code integrations (write)
    • Feature flag integrations
      • LaunchDarkly
    • Impact integrations
      • Error trackers
        • Bugsnag
        • Honeybadger
        • Rollbar
        • Sentry
      • Metric trackers
        • AppDynamics
        • AWS CloudWatch
        • Custom
        • Datadog
        • Jira metrics (Cloud / Data Center)
        • NewRelic
        • SignalFx
      • Incident tracker integrations
        • Blameless
        • PagerDuty
        • Datadog Monitors
        • Statuspage
        • Opsgenie
        • Jira (Cloud/Data Center)
        • FireHydrant
        • Rootly
        • ServiceNow
        • Custom
          • Grafana OnCall
      • CI/CD builds
        • Azure Pipelines
        • Bitbucket Pipelines
        • Buildkite
        • CircleCI
        • GitHub Actions
        • GitLab CI/CD Pipelines
        • Jenkins
    • Sleuth DORA App for Slack
    • Microsoft Teams integration
    • CI/CD integrations
      • Azure Pipelines
      • Bitbucket Pipelines
      • Buildkite
      • CircleCI
      • Github Actions
      • GitLab CI/CD Pipelines
      • Jenkins
    • Issue tracker integrations
      • Jira Cloud
      • Jira Data Center
      • Linear
      • Shortcut
    • Fixing broken integrations
  • Pulse
    • Welcome to Pulse docs
    • Quick Start setup guide
    • Beginner tutorials
      • 1. How to create a Teamspace
      • 2. How to create a Review
      • 3. How to create a Survey
  • Features
    • Reviews
      • Review workflow
      • Review templates
      • Widgets and Sections
        • Widget type
      • Review settings
    • Surveys
      • Survey Workflow
    • Teamspaces
    • Inbox
    • AI assistant
    • General settings
      • Users and Teams
      • Investment mix
  • Settings
    • Organization settings
      • Details
      • Authentication
        • SAML 2.0 Setup
          • Okta Configuration
          • Azure AD Configuration
          • PingIdentity Configuration
      • Access Tokens
      • Members
      • Team Settings
      • Billing
    • Project settings
      • Details
      • Slack settings
      • Environment settings
      • Code deployment settings
      • Feature flag settings
      • Impact settings
    • Account settings
      • Account settings
      • Notifications settings
      • Identities settings
    • Role Based Access Control
  • Resources
    • FAQ
    • Sleuth TV
    • Purchasing
    • About Sleuth...
Powered by GitBook
On this page
  • About the integration
  • Setting up the integration
  • Configuring the integration
  • Removing the integration

Was this helpful?

  1. Integrations
  2. CI/CD integrations

CircleCI

PreviousBuildkiteNextGithub Actions

Last updated 3 years ago

Was this helpful?

About the integration

The CircleCI integration provides Sleuth with the ability to track your CircleCI builds and associate them with your corresponding Sleuth deploys. Once configured, the Sleuth CircleCI integration silently monitors your deployment activity, and ties your CircleCI builds with associated deployments you make to your integrated change sources by matching the git SHAs from your code repos. Sleuth then shows you a snapshot of your build state at the time of deploy.

Setting up the integration

To add the Sleuth CircleCI integration:

  1. Click Integrations in the sidebar.

  2. Click the** CI/CD** tab, then click enable in the CircleCI card.

  3. Enter your CircleCI User API Token, then press Save. To quickly obtain your User API Token, make sure you're logged in to your CircleCI account, then click generate. You will be taken to the Personal API Tokens section of your CircleCI account.

  4. On successful integration, you'll see CircleCI enabled displayed in the CircleCI tile. You'll configure the default build server later.

for more information on generating Personal API Tokens.

Configuring the integration

The Sleuth CircleCI integration configuration simply consists of pointing the CircleCI integration to your projects that you want Sleuth to collect build information for.

To configure the CircleCI integration, you will need to set a default build server:

  1. Click Integrations in the sidebar, then click the Builds tab.

  2. Select a project to set as the default build server. You'll need to add a code deployment to the selected project if you haven't already done so.

Removing the integration

If you wish to disconnect the CircleCI integration for the organization:

  1. Click on Integrations in the left sidebar, then on Builds.

  2. In the CircleCI integration card, click disable. The message CircleCI disabled is displayed in the CircleCI integration card once the integration is dissolved.

The CircleCI integration is disconnected and no longer available to any projects within that organization.

Click the Set default build server dropdown.

Now that the CircleCI integration is configured, you will begin seeing information displayed in the Builds tab of a , as shown below.

deploy
Read the CircleCI documentation
Sleuth CircleCI Personal API Token entry dialog
Generate a new CircleCI Personal API Token in your CircleCI User settings