Connect, view, and disconnect component metrics

Connect a metric to a component

Before you begin

Connecting metrics to components in Compass helps you track their performance and that of their owner teams. Metrics in Compass are global across the site. It means that you can connect a metric available on your Compass site to any component on the same site.

To connect a metric to a component:

1. Go to your component’s Overview page.

2. Select the field under the Metrics section.

   • If you haven't connected any metrics so far, select Connect metrics to measure the performance of your component and team.

   • If you’ve connected at least one metric, select + Connect metric.

3. On the Connect a metric dialog, select a metric from the Metric dropdown list.

   • If your metric isn’t available in the list, create a new one by selecting + Create new metric and then come back here. How to create a new metric

4. Select Connect.

Once you connect a metric to a component, Compass creates a metric source for that metric on the component. A metric source contains values that provide numerical data about the component for a given metric. Tools such as source code repositories, incident trackers, and CI/CD tools, emit these metric values.

Some metric sources automatically calculate values from events on the attached component. See our page on derived metrics for more information.

For all other metric sources, you can use our REST API to push the metric values from your tool to the component’s metric source, and hence on to the component in Compass. We provide you with a cURL command to call the REST API. How to push metric values to a component with a cURL command

View a component's metrics

A component’s metric value gives you an indication of how your component or the team managing the component is performing. Metrics can be distributed across several tools and processes that a software team uses during development and operations, for example, source code repositories, incident tracking tools, or CI/CD tools. Compass gives you the ability to view these metrics from a single place.

You can view a component’s metric values in Compass by connecting a metric to it and pushing metric values to your component.

To view a component’s metrics:

1. Go to your component’s Overview page.

2. Locate the metric you want to view in the Metrics section.

The value of the metric is displayed on the metric tile.

Pin metrics to the top of metrics lists

Bring your teams' attention to the most important metrics by pinning them to the top of the metrics list on components. When several metrics are connected to a component, you can help engineers find and focus on the metrics that matter the most by pinning them to the top of metrics lists.

To pin a metric:

1. In Compass, go to the Health page.

2. Select Metrics.

3. Hover over the metric you'd like to pin and select Pin to top of metrics list.

The pinned metric will always appear at the top of the metrics list on the Overview page of all components to which it’s connected.

To unpin a metric, hover over it and select Unpin from top of metrics list the same way you pinned it.

Disconnect a metric from a component

If you no longer want to track a metric for a component, you can disconnect the metric from it.

Disconnecting a metric from a component also removes the metric from that component along with the metric values associated with that component. If you reconnect the same metric again to the component at a later time, you’ll need to push values again to it. The values prior to the disconnection are not retained.

Disconnecting a metric from a component doesn’t affect other components that have the same metric on them, nor does it delete the metric from the Compass site.

To disconnect a metric:

1. Go to your component’s Overview page.

2. In the Metrics section, locate and hover on the the metric you want to remove.

3. Select More actions icon () on the metric tile for the metric you want to disconnect, then select Disconnect.

4. Select Disconnect.