Last updated Apr 6, 2023

Rate this page:

Create, view, update, and delete scorecards

Create a scorecard

In Compass, you can create new scorecards to measure the health of your components based on your unique requirements.

Creating your own scorecards enables you to:

  • define company-wide standards and policies to ensure that all teams are aiming for the same standards

  • define team-level standards to ensure they follow their own best practices, in addition to the company-wide standards

Before you begin

Before you create a new scorecard, make sure you:

Create a scorecard

We’ll show you how to create custom scorecards in Compass.

To create a scorecard:

  1. In Compass, select Health from the top navigation.
  2. On the Scorecards page, select Create scorecard.
  3. Enter the scorecard’s Name and Description.
  4. Select an Owner. Start typing a name and select the user from the list.
    • An owner is someone who is an expert in the subject area and can be the point of contact. Adding an owner is optional, but we recommend you add one.
  5. Select a Component type.
    • The scorecard becomes available for the components of this type.
  6. Choose how you want this scorecard applied:
    • To all components of a selected type
    • Manually to individual components
    • By a component label
  7. If you selected to apply the scorecard using a component label, search and select a component label from the dropdown menu that appears.
  8. Select Next.
  9. Under Criteria, select a criterion from the list and enter a percentage that reflects its importance.
    • You must add at least one criterion. The sum of the percentages for all criteria must be 100%.
  10. If you need to add another criterion, select Add criterion. Then select a criterion and enter its percentage.
  11. Select Create.

If the scorecard is applied to all components of a selected type, Compass implicitly applies it to all components with a matching component type that you set when you created the scorecard. Scorecards applied via component label are also automatically applied, matching components with that label. A scorecard set to be applied manually can now be applied to individual components from their detail's page.

Delete a scorecard

You can delete scorecards that you no longer want to use.

Scorecard deletion is irreversible. Once you delete it, you'll not be able to recover the scorecard again.

To delete a scorecard:

  1. In Compass, select Health from the top navigation.
  2. Locate the scorecard on the Scorecards page then select Delete on it.
  3. Select Delete on the confirmation dialog. The scorecard no longer applies to any associated components and no longer exists in Compass.

Methods of applying scorecards

You choose the method of applying the scorecard when you create a scorecard using the field How should this scorecard be applied?

Scorecards in Compass can be applied using one of the following methods:

All selected type(s) of components

This method allows you to apply scorecards to all components of selected type(s), where Compass implicitly applies it to all components with a matching component type that you set when you created the scorecard.

Use this method to apply organization-wide criteria to components and ensure that all teams are following the same operational best practices.

By default, the component readiness scorecard is a scorecard applied to all components.

Individual selected types of components

This method is a manual way to apply scorecards, where a component’s type matches the component type that you set in the scorecard’s settings. These scorecards are not mandatory but are the ones that your organization recommends the teams use for all applicable components.

Use this method to apply criteria defined by cross-product or platform teams, such as SRE, security, or DevOps, to components of a particular type.

By a component label

This method of applying scorecards is based on component labels, where a component’s type and component label matches the component type and label that you set when you created the scorecard. These scorecards are not mandatory across the organization, but you can use them for specific components as per your needs.

Use this method to bulk apply scorecards to components of selected type(s) in a more granular way, or apply using labels that match your team or organization structure, categorization, or specific groups of people.

By a component tier

This method of applying scorecards is based on component tier, where a component's type and tier match the type and tier that you set when you created the scorecard. These scorecards are not mandatory across the organization, but you can use them for specific components as per your needs.

Use this method to bulk apply scorecards to components of selected type(s) in a more granular way, or apply using tiers that match your team's prioritization or importance of component(s).

Use regular expressions in scorecard criteria

Use regular expressions (regex) in scorecard criteria to set up policies that specific links be added to components.

A scorecard criterion with regex validation compares the links of the particular type on a component with the regex you provide. The criterion is met when at least one link or its display text matches the regex.

Example

Suppose you want to set up a policy that every service component has a documentation link to a disaster recovery plan. In that case, you can add a scorecard criterion for the Documentation field with regex as \bdisaster\b.*\brecovery\b. This criterion passes when two separate words — disaster and recovery — case-insensitive, but in that order, are part of a documentation link or its display text.

Component readiness scorecard

Your Compass site comes with the following default scorecard:

Component readiness scorecard

The service readiness scorecard measures how ready your service is for use in a production environment and guides you towards further improving it. It is applicable for service components. It's applied to all service components, meaning that it is mandatory for all service components.

The scorecard has the following criteria and weight for each criterion:

CriteriaWeight
The service has a description50%
The service has an owner50%

Rate this page: