Scorecard Checks
Description: This check returns the number of applications associated with a service.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Application Association Count >= 1 passes if the service is associated with 1 or more applications
Description: This check returns the number of CI / CD plugins configured for a service
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: CI / CD Configured >= 1 passes if the service has at least one configured CI / CD plugin
Description: This check returns the number code inspection plugins a service has configured.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Code Inspection Configured >= 1 passes if the service has at least one plugin from the code inspection category configured
Description: This check returns the number of environments associated with a service.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Environment Count >= 2 passes if the service is associated with 2 or more environments
Description: This check returns the number of resources associated with the specified environment for a service.
Parameters: Environment name (select one from dropdown)
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Environment Specific Resource Count >= 2 passes if the service has 2 or more resources in the environment specified by the parameter
Description: This check returns the number issue tracking category plugins a service has configured (Currently supported: JIRA).
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Issue Tracking Configured >= 1 passes if the service has at least one plugin from the issue tracking category configured
Description: This check returns 1 if the service has a lifecycle defined.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Lifecycle defined = 1 passes if the service has its lifecycle field filled in
Description: This check returns the number links of the specified type a service has. Link types supported include
- Runbook
- Metrics
- Logs
- Health Check
- Documentation
- Dashboard
- API
- Other
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Links of selected type >= 1 passes if the service has at least one link of the specified type defined
Description: This check returns 1 if the service has a metadata key of the specified name defined.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Metadata Key Check of the selected value = 1 passes if the service has at a metadata key defined of the selected value
Description: The check looks at a specified metadata key, performs a JSON query, and enables text comparison of the result
Description: The check makes a request to an HTTP endpoint. The request is made using the Axios HTTP client so it enables you to richly configure the request's body and headers. It then enables you to use jq to query the response and then compare the result to a threshold. Currently this metric supports text comparison.
Example: Let's call Github's status api and see if Github is operational.
URL:
https://www.githubstatus.com/api/v2/summary.json
JSON Query: .status.description
Operation: equal
Threshold: All Systems OperationalExample: Setting the URL to (https://dummyjson.com/products/1) or, in a more complex case where you want to specify the request more completely
{ "url": "https://dummyjson.com/products/1", "method": "post", "auth": {
"username": "janedoe",
"password": "s00pers3cret"
}
}
or
{ "url": "https://dummyjson.com/products/1",
"headers": { "Authorization": "Bearer eyJ..." }
}
to fetch example data, you can apply .title as the JSON query to extract the title property, which in this case is "iPhone 9". You can then select an operation (equals for example) and Threshold ("iPhone 9" for example) and the check would return true.
Description: This check returns the number on-call category plugins a service has configured (Currently supported: OpsGenie, PagerDuty).
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: On-Call Configured >= 1 passes if the service has at least one plugin from the on-call category configured
Description: This check returns the number of owners associated with a service.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Owner Count >= 1 passes if the service has 1 or more owners
Description: This check returns 1 if the specified package meets the comparison condition specified
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Package Version for the specified package = 1 if the specified package meets the comparison condition specified
Description: This check returns the number on-call repositories a service has configured.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Repository configured >= 1 passes if the service has at least one repository configured
Description: This check returns true if the selected language meets the comparison criteria specified.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Repository Language Composition for the selected language returns 1 if the operator condition is met.
Description: This check returns true if the selected language is present in the service's repository
Operations: Equal
Threshold: integer number
Example: Repository Language Detection for the selected language returns 1 if the language is present in the service's repository.
Description: This check determines if a repository has received a commit within the specified number of days
Operations: Equal
Threshold: integer number
Example: Repository Last Commit (specified period) = 1 if the repository has a commit within the specified number of days
Description: This check compares the number of required approvals for a repository against the specified value
Operations: Equal
Threshold: integer number
Example: Repository Number of Required Approvals (specified number) = 1 if the repository has at least the specified number of approvals
Description: This check counts the number of PRs opened for a repository over the past N days.
Operations: Equal
Description: This check returns the count of tickets matching the specified JQL Query. You can use any of the configure8 Service Macros in your query to help you specify service attributes for use in your JQL query.
Operations: Equal
Threshold: integer number
Example: (
component = ‘{{service.metadata.JIRAComponentName}}’ >= 1) if the query returns one or more tickets with the JIRAComponentName nickname metadata as the component name. All scorecard checks allow you to have the check pass if there is no data if this option is selected. For example, if no MTTA data is available for a service and Pass on No Data is selected, the check will pass, otherwise if there is data, the returned data will be used to determine if the check passes
-
Last modified 2d ago