In Compass, you can create 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 three scorecards on a Free plan, 50 on a Standard plan, and 100 on a Premium plan.
If your site uses a restricted permission policy, you must be the owner of the scorecard you're changing or a product admin.
Understand the different methods of applying scorecards so that you can apply scorecards using a method that makes sense for your team and the criteria you want to enforce on your components
You can create a scorecard from the scorecard library or from scratch.
To create a scorecard from the scorecard library:
The library includes templates for getting started with scorecards, including Software quality starter, Component readiness, and DevOps health. More will be added over time.
Software quality starter
This scorecard helps you get started tracking key software quality metrics. You can add or remove metrics from this scorecard to fit your organization’s goals.
The scorecard has the following criteria and weight for each criterion:
Criteria | Weight |
---|---|
Build success rate ≥ 95% Install the Bitbucket, GitHub, or GitLab app and add a repository link to your component to populate the Build success rate metric via build events. You can also populate build events using a incoming webhook or via the Compass API. Learn more getting events from connected tools and getting data from your toolchain using incoming webhooks | 30% |
Open bugs ≤ 20 To populate this metric, enable Compass components on your Jira projects and assign Compass components to your open bugs. | 30% |
Quality gate conditions passing = 100% You can populate this metric using the SonarQube webhook. Learn more about getting data from your toolchain using incoming webhooks | 30% |
Owner team is set | 10% |
Component readiness
The Component readiness scorecard ensures that component details are ready for development teams to reference in the catalog.
The scorecard has the following criteria and weight for each criterion:
Criteria | Weight |
---|---|
Owner team is set | 40% |
Repository link added | 40% |
Description populated | 20% |
DevOps health
The DevOps health scorecard helps your team track cycle time, deployment frequency, and more to measure your teams’ DevOps health.
The scorecard has the following criteria and weight for each criterion:
Criteria | Weight |
---|---|
Owner team is set | 25% |
Repository link added | 25% |
Pull request cycle time ≤ 5000 minutes Install the Bitbucket, GitHub, or GitLab app and add a repository link to your component to populate the Pull request cycle time metric via pull request events. | 25% |
Deployment frequency ≥ 5 deploys per week Install the Bitbucket, GitHub, or GitLab app and add a repository link to your component to populate the Deployment frequency metric via deployment events. You can also populate deployment events using a incoming webhook or via the Compass API. Learn more getting events from connected tools and getting data from your toolchain using incoming webhooks | 25% |
To create a scorecard from scratch:
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 details page.
All scorecards are created as drafts. To view scorecard drafts, Select Health from the top navigation in Compass and scroll down to the list of scorecards. You can filter by State.
To publish a draft scorecard:
You may see a warning if you have components that aren’t receiving data required for this scorecard. We recommend completing setup before publishing, but you can still publish without completing the data connection if desired.
Any user with the Edit Scorecards permission can publish scorecards. Once a scorecard it published, it cannot be moved back to draft.
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.
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.
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.
Rate this page: