Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scorecards Final Changes #19638

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/content/docs/scorecards/limitations.mdx
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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/scorecards/limitations.mdx#L8

[Microsoft.Passive] 'are allowed' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'are allowed' looks like passive voice.", "location": {"path": "src/content/docs/scorecards/limitations.mdx", "range": {"start": {"line": 8, "column": 72}}}, "severity": "INFO"}
- **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

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/scorecards/limitations.mdx#L9

[Microsoft.Passive] 'is associated' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is associated' looks like passive voice.", "location": {"path": "src/content/docs/scorecards/limitations.mdx", "range": {"start": {"line": 9, "column": 40}}}, "severity": "INFO"}
These limitations ensure system performance and manageability while in limited preview mode.



22 changes: 22 additions & 0 deletions src/content/docs/scorecards/rule-view.mdx
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 that 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, indicating whether each one passes or fails. This allows users to identify problem areas.

- **Rule score calculation:** Each rule’s score is calculated as a percentage of passing checks to total checks, enabling assessment of rule adherence.

Check notice on line 18 in src/content/docs/scorecards/rule-view.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/scorecards/rule-view.mdx#L18

[Microsoft.Passive] 'is calculated' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is calculated' looks like passive voice.", "location": {"path": "src/content/docs/scorecards/rule-view.mdx", "range": {"start": {"line": 18, "column": 51}}}, "severity": "INFO"}

- **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.
Loading
Loading