In Compass, you can create custom 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
You can create a maximum of one scorecard on a Free plan and 50 on a Standard plan.
Before you create a custom scorecard, make sure you:
To create a scorecard:
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.
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:
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.
Built-in scorecards are applied automatically. The component readiness scorecard applies to all your components, and the DevOps scorecard is automatically applied to all your service 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 (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.
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 . This criterion passes when two separate words — and — case-insensitive, but in that order, are part of a documentation link or its display text.
Rate this page: