Skip to content

Commit ddbff4c

Browse files
authored
RHIDP-8709: Scorecard plugin (#1465)
* Scorecard plugin * Incorporated tech changes * Ihor's and some minor changeS * Updated Abstract * Dominika's comments - some of them * Incorporated Dominika's comments and added images * Dominika's comments * Minor changes * Incorporated Dominika's comments and rebased branch * Incorporated some of the test day comments * Fixing build issue * Test day updates * Test day updates * test day minor change * Incorporated Dominika's comments * Incorporated Shipra's comments * Incorporated Shipra's comments * Minor changes
1 parent c0d7825 commit ddbff4c

29 files changed

+715
-1
lines changed

artifacts/attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,6 @@
168168
:upgrading-book-title: Upgrading {product}
169169
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170170
:using-dynamic-plugins-book-title: Using dynamic plugins
171+
172+
:scorecard-plugin-book-link: {product-docs-link}/html-single/understanding_and_visualizing_red_hat_developer_hub_project_health_using_scorecards/index
173+
:scorecard-plugin-book-title: Understanding and visualizing {product} project health using Scorecards
File renamed without changes.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
This section describes Developer Preview features in the Scorecard plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
4+
5+
For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
6+
====
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-configuring-scorecards-in-rhdh"]
4+
= Installing and configuring Scorecards to view metrics in your {product} instance
5+
:context: assembly-configuring-scorecards-in-rhdh
6+
7+
You can install and configure the following Scorecards to display metrics and visual health status for software components in the {product-very-short} catalog:
8+
9+
* GitHub Scorecards
10+
* Jira Scorecards
11+
12+
include::modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc[leveloffset=+1]
13+
14+
include::modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc[leveloffset=+1]
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-rhdh-observability"]
4+
= Understanding and visualizing {product} project health using Scorecards
5+
:context: assembly-scorecards-rhdh
6+
7+
include::modules/observe/scorecards/con-understand-scorecard-plugins.adoc[leveloffset=+1]
8+
9+
include::modules/observe/scorecards/ref-supported-metrics-providers.adoc[leveloffset=+2]
10+
11+
include::assembly-setting-up-scorecards-to-monitor-your-rhdh-health.adoc[leveloffset=+1]
12+
13+
include::assembly-configuring-scorecards-in-rhdh.adoc[leveloffset=+1]
14+
15+
include::modules/observe/scorecards/con-manage-metric-thresholds-in-scorecard-plugin.adoc[leveloffset=+1]
16+
17+
include::modules/observe/scorecards/con-how-thresholds-work.adoc[leveloffset=+2]
18+
19+
include::modules/observe/scorecards/ref-supported-threshold-expressions.adoc[leveloffset=+2]
20+
21+
include::modules/observe/scorecards/ref-threshold-rules-to-metrics-for-scorecard-plugin.adoc[leveloffset=+2]
22+
23+
include::modules/observe/scorecards/con-set-global-standards-for-metric-thresholds.adoc[leveloffset=+2]
24+
25+
include::modules/observe/scorecards/ref-override-rules-to-configure-entity-specific-thresholds.adoc[leveloffset=+2]
26+
27+
include::modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc[leveloffset=+2]
28+
29+
include::modules/observe/scorecards/proc-viewing-scorecards-in-rhdh.adoc[leveloffset=+1]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-setting-up-scorecards-to-monitor-your-rhdh-health"]
4+
= Setting up Scorecards to monitor your {product} project health
5+
:context: assembly-setting-up-scorecards-to-monitor-your-rhdh-health
6+
7+
include::modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc[leveloffset=+1]
8+
9+
include::modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc[leveloffset=+1]
107 KB
Loading

images/rhdh/scorecard-sample.png

102 KB
Loading

modules/developer-lightspeed/con-about-developer-lightspeed.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="con-about-developer-lightspeed_{context}"]
44
= About {ls-short}
55

6-
include::{docdir}/artifacts/snip-developer-preview.adoc[]
6+
include::{docdir}/artifacts/snip-developer-preview-lightspeed.adoc[]
77

88
This early access program enables customers to share feedback on the user experience, features, capabilities, and any issues encountered. Your input helps ensure that {ls-short} better meets your needs when it is officially released and made generally available.
99

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="con-best-practices-for-threshold-rules"]
4+
= Best practices for threshold rules
5+
6+
Threshold rule evaluation is order-dependent. You must follow logical ordering to avoid unintended category assignments, as the system stops evaluation once a value matches the first rule.
7+
8+
== Follow logical ordering
9+
10+
Rules must be sequenced logically. Order rules from the most strict (smallest range) to the least strict (largest range) or ensure all ranges are mutually exclusive.
11+
12+
=== Problematic rule order example
13+
14+
If rules are ordered incorrectly, a less restrictive rule can prevent stricter rules from being evaluated:
15+
16+
. `warning: <50`: Any value less than 50 triggers the warning rule and stops evaluation.
17+
. `success: <10`: This rule is not evaluated because all values less than 10 have already matched the preceding warning rule.
18+
19+
=== Correct ordering example
20+
21+
Order the rules from the most restrictive value range to the least restrictive to ensure a logical flow.
22+
23+
[source,yaml]
24+
----
25+
# Correct Example: Order from most restrictive (Success) to least restrictive (Error)
26+
rules:
27+
- key: success
28+
expression: '<10' # Only values below 10
29+
- key: warning
30+
expression: '10-50' # Only values between 10 and 50
31+
- key: error
32+
expression: '>50' # All remaining values above 50
33+
----

0 commit comments

Comments
 (0)