Use metrics with scorecards
A metric is a quantifiable measure of behavior observed and collected from your systems, tools, and processes. Metrics provide data points that help you track and assess the performance of your processes, products, and teams.
How do scorecards use metrics?
Compass scorecards are the method of implementing metric thresholds on your components.
When you connect a metric to a component, the metric description, value, and unit are displayed on the component details page. The metric then becomes available in the criterion dropdown when editing and creating a scorecard. How to connect metrics to a Compass component
When the scorecard is created with metrics as criteria, those criteria are displayed on the scorecard on any components the scorecard is applied to.
What are metric thresholds?
A metric threshold is the defined value which the metric must fall over, under, equal, or not equal to, in order to be satisfied as a scorecard criterion. You can think of a metric threshold as a limit set to convey a healthy status.
In Compass, metric thresholds are defined in the scorecard criterion. This threshold doesn’t appear on the metric itself, nor the components the metric is displayed on. The threshold is displayed on a scorecard with a metric criterion defined in the component details view, and on the scorecard itself.
Metric thresholds are defined when you create a scorecard with a metric criterion or edit a scorecard to add metrics. Thresholds consist of a metric selected, an operator (less than, greater than, etc), and then the value. The unit is taken from what’s defined on the metric itself.
Add a metric as a scorecard criterion
Compass provides several predefined metrics for you to use for your components. See the full list of predefined metrics in Compass here: Available predefined metrics in Compass. You can use these predefined metrics as scorecard criteria, or if you want to use a different metric, you’ll need to first create the metric in Compass. Learn more about creating metrics
Before you begin
If your site uses a restricted permission policy, you must be the owner of the scorecard you're changing or a product admin.
Select Health from the top navigation bar in Compass.
Select Create a new scorecard or to add a metric to an existing scorecard, find the scorecard and select Edit.
Fill in the required scorecard fields or make any desired changes to the existing scorecard you selected. Learn more about creating and managing scorecards
Select Next.
Select the Select criterion dropdown menu and find the metric you want to add as a criterion.
If you don’t see the metrics you expect, you may need to create them first.
Select the metric criterion. Two new fields appear.
Select the operator you want the metric threshold to have from the dropdown menu.
Enter the value for the metric threshold.
Enter the weight, by percentage, that this criterion should have. The sum of each criterion’s weight should be 100.
Add whatever additional criterion you want this scorecard to have.
Select Create (or Save) when all your criterion is added and your criterion’s weights all add to 100%.
Now your scorecard has metric criteria and is applied to components according to the scorecard’s settings. The scorecard displays the metrics with any other criteria defined in the scorecard on applicable components.
Remove a metric as a scorecard criterion
Select Health from the top navigation bar in Compass.
Select the scorecard with the metric you want to remove.
Select Edit scorecard.
Edit any other details on the scorecard's main details, then select Next.
Select the remove icon next to the metric(s) you want to remove from this scorecard. You must adjust the weight of your other criteria so that the sum of the criterion’s weights equals 100.
Select Save when all your changes are made. Any components with that scorecard applied will reflect your changes and scores are recalculated accordingly.
Was this helpful?