-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
14 changed files
with
654 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Limitations | ||
--- | ||
As Scorecards are in a public preview, the following restrictions apply: | ||
|
||
- **Entity limit:** Maximum of 5,000 entities per rule. | ||
- **Rule limit:** Maximum of 1,000 rules per organization. | ||
- **Allowed dimensions:** Only `team`, `department`, and `environment` are allowed. | ||
Check notice on line 8 in src/content/docs/scorecards/limitations.mdx GitHub Actions / vale[vale] src/content/docs/scorecards/limitations.mdx#L8
Raw output
|
||
- **Scorecard association:** If a rule is associated with more than one scorecard, only the last scorecard will consider the rule. | ||
Check notice on line 9 in src/content/docs/scorecards/limitations.mdx GitHub Actions / vale[vale] src/content/docs/scorecards/limitations.mdx#L9
Raw output
|
||
These limitations ensure system performance and manageability while in limited preview mode. | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: Rule view | ||
--- | ||
<img | ||
title="Rules view" | ||
alt="Rules view" | ||
src="/images/rules-view.webp" | ||
/> | ||
|
||
Rules are the building blocks of Scorecards. Rules contain specific performance conditions for compliance. The rule view enables users to assess and manage individual rules, offering visibility into entities to meet or fail the conditions of each rule. | ||
|
||
- <DNT>**Rule description:**</DNT> Each rule includes a description, New Relic Query Language (NRQL) statement, and scope (the entities or accounts it evaluates). Users can examine these rules to understand the purpose and criteria of each rule. | ||
|
||
- **Evaluation summary:** | ||
|
||
- <DNT>**Status (Pass/Fail):**</DNT> It shows a list of all the entities evaluated by the rule, showing whether each one passes or fails. This allows users to quickly identify problem areas. | ||
Check notice on line 16 in src/content/docs/scorecards/rule-view.mdx GitHub Actions / vale[vale] src/content/docs/scorecards/rule-view.mdx#L16
Raw output
|
||
|
||
- **Rule score calculation:** Each rule’s score is calculated as a percentage of passing checks to total checks, enabling quick assessment of rule adherence. | ||
Check notice on line 18 in src/content/docs/scorecards/rule-view.mdx GitHub Actions / vale[vale] src/content/docs/scorecards/rule-view.mdx#L18
Raw output
|
||
|
||
- **Manage entities:** Users can update the scope of each rule by adding or removing specific entities. | ||
|
||
- **Enable/disable rules:** It allows users to toggle rules on or off, based on relevance to current engineering standards. |
Oops, something went wrong.