Scorecards Final Changes #19638
Scorecards Final Changes #19638
Conversation
Scorecards Final Changes
newrelic707195
added
content
|
Hi @newrelic707195 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
Updated Scorecards
|
newrelic707195
requested review from
vpayyapilly
and removed request for
cbehera-newrelic
| 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. |
There was a problem hiding this comment.
...entities that meet...
|
|
||
| - **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. |
There was a problem hiding this comment.
...rule, indicating whether...
I would avoid using adjectives like "quickly" unless we have metrics to back it up.
|
|
||
| - <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. | ||
|
|
||
| - **Rule score calculation:** Each rule’s score is calculated as a percentage of passing checks to total checks, enabling quick assessment of rule adherence. |
|
|
||
| - **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. |
| --- | ||
| title: Scorecards API | ||
| --- | ||
| All rules of Scorecards belong to the rules collection of the Scorecard. Therefore, both `scorecardId` and `collectionId` are needed to know which scorecard owns a rule. |
There was a problem hiding this comment.
The first sentence needs to be clearer
| --- | ||
| All rules of Scorecards belong to the rules collection of the Scorecard. Therefore, both `scorecardId` and `collectionId` are needed to know which scorecard owns a rule. | ||
|
|
||
| Below is an example of creating a rule that checks whether your APM services have alerts defined. |
There was a problem hiding this comment.
This is an example of a rule...
|
|
||
| Below is an example of creating a rule that checks whether your APM services have alerts defined. | ||
|
|
||
| 1. Create a scorecard |
| } | ||
| ``` | ||
|
|
||
| 2. Create a rule |
| - `name:` The name of the scorecard. | ||
| - `description:` A brief description of the scorecard. | ||
| - `accountId:` Account where the entity will be stored. | ||
| - `query:` A nrql query to read data. |
There was a problem hiding this comment.
NRQL is always capitalized
|
|
||
| ### Use cases | ||
|
|
||
| 1. **Get rules in a Scorecard:** Retrieve all rules associated with a specific scorecard. |
There was a problem hiding this comment.
Why is this a numbered list?
|
|
||
| - `collectionId` is the value from previous response `rules.id`. | ||
|
|
||
| 2. **Get the scorecard of a rule** retrieve the scorecard associated with a specific rule. |
There was a problem hiding this comment.
Format doesnt match the previous point
| - `accountId:` Account where the entity will be stored. | ||
| - `query:` A nrql query to read data. | ||
| - A `score` is a mandatory selection. | ||
| - A FACET with at least and entity id (entity.guid, entity.id or entityGuid) is mandatory. |
There was a problem hiding this comment.
Check grammar. Something is off.
| - `query:` A nrql query to read data. | ||
| - A `score` is a mandatory selection. | ||
| - A FACET with at least and entity id (entity.guid, entity.id or entityGuid) is mandatory. | ||
| - `queryAccounts:` A list of accounts where the rule should execute the query. |
There was a problem hiding this comment.
...rule should run the query
| - A FACET with at least and entity id (entity.guid, entity.id or entityGuid) is mandatory. | ||
| - `queryAccounts:` A list of accounts where the rule should execute the query. | ||
|
|
||
| Create a scorecard, follow step no: 3 and all rule guid to scorecard collection id. |
|
|
||
| - `id:` The target scorecard/rule id. | ||
|
|
||
| 6. **Modify a Scorecard** Update the details of an existing scorecard. |
|
|
||
| **GraphQL Mutation:** | ||
|
|
||
| The update operation is similar to creating one, but the mutation name is different. |
|
|
||
| **Fields:** | ||
|
|
||
| - `id:` Scorecard entity guid. |
There was a problem hiding this comment.
GUID
update globally in this document
| } | ||
| ``` | ||
|
|
||
| **Fields:** |
There was a problem hiding this comment.
The descriptions are not consistent with the earlier instances.
|
|
||
| **GraphQL Mutation:** | ||
|
|
||
| Fields are the same for update and create, with different name in the mutation and with id of entity. |
| - `name:` Name of the scorecard rule. | ||
| - `description:` Description of the scorecard rule. | ||
| - `query:` NRQL query to read data. | ||
| - `queryAccounts:` List of accounts where the data need to be read. |
| **Fields:** | ||
|
|
||
| - `id`: Entity Id of the rule. | ||
| - `query`: New query. |
|
|
||
| - `id`: Entity Id of the rule. | ||
| - `query`: New query. | ||
| - `Accounts`: Target list of accounts IDs, if empty, the query won’t run in any account. |
| --- | ||
| title: Scorecards rules | ||
| --- | ||
| To effectively understand scorecards, it is essential to recognize that rules are predefined criteria or conditions used to evaluate performance against specific objectives. These rules form the foundation for assessing whether performance metrics meet the desired standards. |
There was a problem hiding this comment.
avoid unnecessary adjectives. Delete "effectively"
| Score evaluation is a systematic process used to assess and quantify performance across various metrics and criteria. Some evaluation parameters are listed below: | ||
|
|
||
| - **Check score:** | ||
| A check is a specific query executed against an entity to determine if a condition is met. The outcome of a check can only be either true or false. Each check is associated with a single rule and represents the smallest evaluative unit within the rule. |
There was a problem hiding this comment.
...determine whether...
| A check is a specific query executed against an entity to determine if a condition is met. The outcome of a check can only be either true or false. Each check is associated with a single rule and represents the smallest evaluative unit within the rule. | ||
|
|
||
| - **Rule score:** | ||
| The rule score reflects the performance of all checks associated with that rule. |
There was a problem hiding this comment.
Proper nouns should be capitalized
|
|
||
| <Collapser | ||
| id="creating-rule-nrql" | ||
| title="Creating rule NRQL"> |
| <Collapser | ||
| id="creating-rule-nrql" | ||
| title="Creating rule NRQL"> | ||
| Rules are based on NRQL (New Relic Query Language) queries executed against the New Relic Database (NRDB). Each rule spans multiple entities and checks whether each entity meets specific conditions by evaluating to either `true` or `false`. Essentially, a rule verifies whether each entity complies with the defined criteria. |
There was a problem hiding this comment.
replace "executed" with "run"
| id="components-of-a-scorecards-rules" | ||
| title="Components of a rule NRQL"> | ||
|
|
||
| A Rule NRQL must contain the following components: |
There was a problem hiding this comment.
Inconsistent capitalization of "rule". Fix.
|
|
||
| A Rule NRQL must contain the following components: | ||
|
|
||
| 1. **Facet by** `entityGuid:` This identifies each entity individually within the query. |
|
|
||
| 1. **Score Column:** The score column reflects the rule’s result for each entity. It evaluates as: `1:` The entity meets the rule (passes). `0:` The entity does not meet the rule (fails). `-1:` No data is available for the entity (defaults to failure). | ||
|
|
||
| Example of NRQL rule: |
|
|
||
| Example of NRQL rule: | ||
|
|
||
| The following example checks if each APM service has alerts configured: |
|
|
||
| ### Example use cases for Entity Event | ||
|
|
||
| - **Check for alerts configuration:** The example query above checks if APM services have alerts configured. |
| Go to **[one.newrelic.com](https://one.newrelic.com) > All Capabilities >** and click **Scorecards** | ||
|
|
||
|
|
||
| The above shown dashboard area is dynamic in nature. This dynamic quality is essential for providing real-time insights and enabling users to interact with the data in meaningful ways. This dynamicity serves as the starting point for users to access and manage all scorecards, offering a comprehensive view of engineering performance across the organization. |
There was a problem hiding this comment.
The area of the dashboard shown here is dynamic. It provides real-time insights while enabling users to interact...
"This dynamicity serves" what does this even mean? Dynamicity is not even a word.
|
|
||
| The above shown dashboard area is dynamic in nature. This dynamic quality is essential for providing real-time insights and enabling users to interact with the data in meaningful ways. This dynamicity serves as the starting point for users to access and manage all scorecards, offering a comprehensive view of engineering performance across the organization. | ||
|
|
||
| Use the [filters](https://docs.newrelic.com/docs/new-relic-solutions/new-relic-one/core-concepts/search-filter-entities/#find) to customize the view based on your preferences. You can filter by department, team, scorecard name, or by scorecard status. The dashboard provides a high-level overview of the organization's performance, with the ability to drill down into specific scorecards for detailed insights. You can see this type of capability into [Single Scorecards view](/docs/scorecards/single-scorecard-view/). |
There was a problem hiding this comment.
"You can see this type of capability into [Single Scorecards view]" what????
|
|
||
| Explore these 20 methods for sending data to New Relic to help you design comprehensive rules and maximize your Scorecards potential: | ||
|
|
||
| [click here](https://newrelic.com/blog/how-to-relic/20-ways-send-data-new-relic) |
|
|
||
| The single Scorecard view provides a deep dive into the specific metrics and rules associated with a single scorecard, including historical performance data. This view is crucial for understanding detailed scoring criteria and driving targeted actions to improve team performance. | ||
|
|
||
| Clicking on the name of Scorecards takes you to deep dive into the the details of the selected Scorecards at any level. In the above screen, clicking on the selected Scorecards **NR Obserability best practices** will take you to the granular details as mentioned in the below Scorecards performance parameters section. |
There was a problem hiding this comment.
Click the name of a Scorecard to dive deeper in....
We do not use "click on" or "clicking on"...it is just "clicking" or "click"
"selected Scorecards NR Obserability best practices will" what does this mean?
|
|
||
| - **Scorecards performance parameters:** | ||
|
|
||
| - **Historical data:** The historical data provides visibility about trends in Scorecards performance over time, with data visualisation options to track improvements or declines. |
There was a problem hiding this comment.
"or declines." what???
| - **Scorecards performance parameters:** | ||
|
|
||
| - **Historical data:** The historical data provides visibility about trends in Scorecards performance over time, with data visualisation options to track improvements or declines. | ||
| - **Current score:** The current score is the overall score calculated as the average of all rule scores within the Scorecards. It represents an immediate sense of compliance with engineering standards. |
There was a problem hiding this comment.
"the Scorecards" is wrong
|
|
||
| The Teams view allows users to visualize Scorecards performance organized by teams. This view aggregates Scorecards data at the team level, making it easier to monitor, compare, and assess how individual teams are meeting organizational engineering standards. | ||
|
|
||
| This view is particularly useful for managers and leaders who need a team-centric perspective of Scorecards compliance and performance. It allows you to access the Teams View by clicking on the **Group By** button on the top right corner of the screen. If you are not enrolled in the teams product, please contact your account manager to be enrolled in Teams product public preview. |
There was a problem hiding this comment.
Scorecards' compliance and performance
Again "clicking on"
"View by clicking on the Group By button on the top right corner of the screen" reason, location, action
...enrolled in the public preview
Scorecards Final Changes - Scorecards-NR-353690-Ltd-PP-Final