Search
K
Comment on page

Scorecard Checks

Check Details

Service Metadata Checks

Application Association Count

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

CI / CD Configured

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

Code Inspection Configured

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

Environment Count

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

Environment Specific Resource Count

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

Filtered Environment-Specific Resource Count

Description: This check returns the number of resources associated with the specified environment for a service filtered by a query that check properties inside that resource.
Parameters: Environment name (select one from dropdown), Resource type, Property to check, Value to check.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Let's say you want to check for the value LastUpdatedStatus inside the Configuration property of a Lambda Instance resource:
MemorySize
128
PackageType
Zip
Configuration
CodeSha256 :HssmIMk6jmnU04in6oz8XsA63ZisBeqVoKHBVUCWJUU=
CodeSize :4995
Description :A starter AWS Lambda function.
EphemeralStorage
Size :512
FunctionArn :arn:aws:lambda:eu-north-1:943404759651:function:serverlessrepo-hello-world-helloworld-YFTTGjlgiHIZ
FunctionName :serverlessrepo-hello-world-helloworld-YFTTGjlgiHIZ
Handler :index.handler
LastModified :2021-11-03T15:25:07.462+0000
LastUpdateStatus :Successful
MemorySize :128
So you can create this check selecting the parameters: Environment Name: Production
Resource Type: AWS:LAMBDA:Instance
Property to check: Configuration.LastUpdateStatus
Value to check: Successful
Operation: greater than or equal
Threshold: 1
So the check will return true if it finds 1 or more resources in that service and environment that matches the Property and Value.

Issue Tracking Configured

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

Lifecycle Defined

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

Metadata Key Check

Description: This check returns 1 if the service has a metadata of the specified name defined. Can look for name, type or value properties.
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/type/value defined of the selected value

Metadata Match

Description: The check looks at a specified metadata key, performs a JSON query, and enables text comparison of the result
Operations: Equal, contains text, text begins with, text ends with, text matches regexp
Threshold: the comparison value
Example: Let's look to see if a metadata key/value (category/landing) is present on a service.
Meta tag name: category JSON Query: <empty> Operation: equal Threshold: landing
Example: Let's look to see if a metadata key/value (config/{json}) has an address field that matches CC:22:3D:E3:CE:30. The example metadata on the service looks like:
Meta tag name: config JSON Query: .address Operation: equal Threshold: CC:22:3D:E3:CE:30

HTTP Match

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 Operational
Example: 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.

On-Call Configured

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

Owner Count

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

Package Version

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: version (1.5.0)
Example: Package Version for the specified package = 1 if the specified package meets the comparison condition specified

Repository Configured

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

Repository Language Composition

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.

Repository Language Detection

Description: This check returns true if the selected language is present in the service's repository
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number
Example: Repository Language Detection for the selected language returns 1 if the language is present in the service's repository.

Repository Last Commit

Description: This check determines if a repository has received a commit within the specified number of days
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number - number of days
Example: Repository Last Commit (specified period) = 1 if the repository has a commit within the specified number of days

Repository Number of Required Approvals

Description: This check compares the number of required approvals for a repository against the specified value
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number - number of approvals
Example: Repository Number of Required Approvals (specified number) = 1 if the repository has at least the specified number of approvals

Repository Open PRs Count

Description: This check counts the number of PRs opened for a repository over the past N days.
Days to count: Number of days window you want to check the open PR's
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number - number of Open PR's in that days

Repository File Contents Matches Regular Expression

Description: This check looks at the contents of a specified file in a service's repository and determines if the contents match a specified regular expression
Example: Check the README.md file and see if "Troubleshooting" is present
File Name: README.MD Regexp: Troubleshooting Operation: Greater than or equal to Threshold: 1

Repository File Exists

Description: This check validates if a specific file or folder exists in the service repository.
filename: Case-sensitive filename with complete path. So if it's a subfolder it should be specified like this sub_folder/sub_file_name.xx
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number

JIRA Ticket Count

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, less than, less than or equal, greater than, greater than or 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.

Dependabot Vulnerability Count

Description: This check returns the count of Dependabot vulnerabilities by the selected Severity.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number

SonarQube Metric Count

Description: This check returns the count of SonarQube metrics. You need to select a service so we can pull the list of metrics available. Later it will fetch that metric for all applied services.
Operations: Equal, less than, less than or equal, greater than, greater than or equal
Threshold: integer number

Pass on No Data

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
Copyright © 2023 configure8, Inc. All rights reserved.