Last updated Mar 2, 2020

Rate this page:

Get metrics from integrated tools

In Compass, there are two main methods for pulling in metric data. One method is by pushing metric values using a cURL command and the other is by automatically connecting metrics when you add a relevant link to the component details page from a configured integration.

The metrics that are pulled in from integrated tools correspond to the predefined metrics available in Compass.

We currently support the Bitbucket Cloud integration for automatically pulling in metric data. More tools are coming soon!

Before you begin

  • Depending on your current configurations, you may not need to do anything to set this up. If you’ve already installed Bitbucket Cloud and have added a link to a repository with existing data to a component, then the metrics automatically backfill and are displayed under Metrics on the component’s details page.
  • Ensure that you are an admin on:
    • the app’s workspace or organization that you want to connect with Compass
    • your Compass instance

Get metrics from an integrated tool

  1. Follow the steps outlined in our documentation to integrate with your chosen tool, such as Bitbucket Cloud: Integrate Compass with Bitbucket Cloud
  2. Add a repository link to a component. For example, for Bitbucket Cloud you would:
    • In Bitbucket, copy the link to your component’s repository.
    • Go to your component in Compass.
    • In the Overview page of your component’s details, add the link in the Repositories section.

Learn more about adding links to a component's resources

Note: If you’re already connected to a tool and have added a repository link to your component, the metrics automatically backfill and are added to the component. Check the component and refresh the page to see the metric values appear.

The component details view with the repository field highlighted

Relevant metrics such as Pull Request Cycle Time and Deployment Frequency are automatically added to the Metrics section with their corresponding metric values.

Troubleshooting

If the Pull Request Time and Deployment Frequency metrics don’t appear after following these steps:

  • Make sure your Bitbucket integration app is up-to-date (Check the Apps page to confirm)
  • Make sure the linked repository on the component is part of the workspace connected to the integrated tool
  • If you see the metrics cards but not the metric values, make sure the linked repository has:
    • Deployments on the main/default branch within the last 28 days
    • Merged pull requests

Rate this page: