From b4c9aa1b7d8874ff4210ae1a7dd4a6cc46963e05 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Tue, 19 May 2026 16:37:28 -0400 Subject: [PATCH 1/3] RHIDP-12523: Platform engineer should be able to drill down from the card into the entities it represents --- ...c-configure-aggregated-scorecard-kpis.adoc | 31 +++++++++++++++ ...specific-services-impacting-team-kpis.adoc | 39 +++++++++++++++++++ ...gregated-scorecard-metric-definitions.adoc | 23 +++++++++++ 3 files changed, 93 insertions(+) create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/ref-aggregated-scorecard-metric-definitions.adoc diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc new file mode 100644 index 00000000000..ad6c6e12ae0 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc @@ -0,0 +1,31 @@ +:_mod-docs-content-type: PROCEDURE + +[id="configure-aggregated-scorecard-kpis_{context}"] += Configure Aggregated Scorecard KPIs to Monitor the Health of Multiple Applications + +[role="_abstract"] +Aggregated scorecard Key Performance Indicators (KPIs) enable platform engineers to monitor the collective health, security, and compliance posture of multiple software applications from a single interface. + +[NOTE] +==== +When you add multiple components to a scorecard, the system calculates an average compliance value. To maintain precision, ensure that all selected applications utilize matching verification metrics. +==== + +== Prerequisites + +* You have administrator access to the developer portal instance. +* You have a verified list of the software component IDs that you want to aggregate. + +== Procedure + +. Navigate to the *Administration* workspace in the developer portal. + +* select *Scorecard Configuration* from the left panel. + +. Click *Create Aggregated Card*. + +. In the *Component Selection* field, enter the application component IDs that you want to group together. + +. From the *KPI Metrics* drop-down list, select the compliance checks—such as code quality, vulnerability thresholds, or test coverage—that you want to combine. + +. Click *Save Configuration*. diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc new file mode 100644 index 00000000000..c07bad8af05 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc @@ -0,0 +1,39 @@ +:_mod-docs-content-type: PROCEDURE + +[id="drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis_{context}"] += Drill Down From Aggregated Scorecards to Identify Specific Services Impacting Team KPIs + +[role="_abstract"] +Drilling down into aggregated scorecard metrics allows engineering managers to isolate the specific software services or applications that are negatively impacting broader performance KPIs. + +[NOTE] +==== +The breakdown view displays code repositories, software components, and dependencies in a descending impact stack. Services with critical errors or security vulnerabilities appear at the top of the stack and require immediate remediation. +==== + +.Prerequisites + +* You have an active user account with access to the Engineering Leadership Dashboard viewport. +* One or more aggregated scorecard Key Performance Indicators (KPIs) are already configured and deploying metrics. + +.Procedure + +. Open the *Engineering Leadership Dashboard* in your portal viewport. + +. Locate the aggregated scorecard widget for your department ecosystem. + +. Hover your mouse pointer over any tracking line that displays a decreasing health grade or safety alert. + +. Click the specific KPI score value to reveal the granular breakdown window. + +. Select the name of any degraded software service within the breakdown list to navigate directly to its isolated health path. + +== Aggregated Scorecard Metric Definitions + +[cols="1,2", options="header"] +|=== +| KPI Card Element | Evaluation Rule +| Combined Grade | The aggregate letter score representing your software components' average check results. +| Contributing Services | The total number of individual applications sending live metrics to the consolidated card calculation. +| Core Vulnerabilities | The cumulative count of high-severity safety exposures identified inside child software layers. +|=== \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/ref-aggregated-scorecard-metric-definitions.adoc b/modules/observability_evaluate-project-health-using-scorecards/ref-aggregated-scorecard-metric-definitions.adoc new file mode 100644 index 00000000000..3ee35dae381 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/ref-aggregated-scorecard-metric-definitions.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: REFERENCE + +[id="aggregated-scorecard-metric-definitions_{context}"] += Aggregated Scorecard Metric Definitions + +[role="_abstract"] +Review definitions and evaluation rules for the Key Performance Indicator (KPI) metrics displayed on {product} aggregated scorecards. + +Use these reference definitions to interpret card data when monitoring multi-application systems or diagnosing underlying compliance failures. + +[cols="1,2", options="header"] +|=== +| KPI Card Element | Evaluation Rule + +| Combined Grade +| The aggregate letter score representing your software components' average check results. + +| Contributing Services +| The total number of individual applications sending live metrics to the consolidated card calculation. + +| Core Vulnerabilities +| The cumulative count of high-severity safety exposures identified inside child software layers. +|=== \ No newline at end of file From 21d456e57e24eada67043750d6298131df315960 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Tue, 19 May 2026 16:48:59 -0400 Subject: [PATCH 2/3] RHIDP-12523: added modules to assembly file --- ...ssembly-monitor-collective-health-across-components.adoc | 6 ++++++ ...pis-to-monitor-the-health-of-multiple-applications.adoc} | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) rename modules/observability_evaluate-project-health-using-scorecards/{proc-configure-aggregated-scorecard-kpis.adoc => proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc} (92%) diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index 863504b396d..e06534da957 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -11,6 +11,12 @@ As an administrator, you can use the Scorecard plugin to view the collective tec include::../modules/observability_evaluate-project-health-using-scorecards/con-monitor-portfolio-health-with-aggregated-kpis.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/ref-aggregated-scorecard-metric-definitions.adoc[leveloffset=+1] + include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1] diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc similarity index 92% rename from modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc rename to modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc index ad6c6e12ae0..9aba92158a9 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: PROCEDURE -[id="configure-aggregated-scorecard-kpis_{context}"] +[id="configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications_{context}"] = Configure Aggregated Scorecard KPIs to Monitor the Health of Multiple Applications [role="_abstract"] From d6db1eb06f105f956f41310ef768f6014373b10b Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Tue, 19 May 2026 17:00:34 -0400 Subject: [PATCH 3/3] RHIDP-12523: fixed items flagged for CQA --- ...to-monitor-the-health-of-multiple-applications.adoc | 6 +++--- ...identify-specific-services-impacting-team-kpis.adoc | 10 ---------- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc index 9aba92158a9..56502191420 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc @@ -11,16 +11,16 @@ Aggregated scorecard Key Performance Indicators (KPIs) enable platform engineers When you add multiple components to a scorecard, the system calculates an average compliance value. To maintain precision, ensure that all selected applications utilize matching verification metrics. ==== -== Prerequisites +.Prerequisites * You have administrator access to the developer portal instance. * You have a verified list of the software component IDs that you want to aggregate. -== Procedure +.Procedure . Navigate to the *Administration* workspace in the developer portal. -* select *Scorecard Configuration* from the left panel. +. select *Scorecard Configuration* from the left panel. . Click *Create Aggregated Card*. diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc index c07bad8af05..d0ec58bfe05 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-drill-down-from-aggregated-scorecards-to-identify-specific-services-impacting-team-kpis.adoc @@ -27,13 +27,3 @@ The breakdown view displays code repositories, software components, and dependen . Click the specific KPI score value to reveal the granular breakdown window. . Select the name of any degraded software service within the breakdown list to navigate directly to its isolated health path. - -== Aggregated Scorecard Metric Definitions - -[cols="1,2", options="header"] -|=== -| KPI Card Element | Evaluation Rule -| Combined Grade | The aggregate letter score representing your software components' average check results. -| Contributing Services | The total number of individual applications sending live metrics to the consolidated card calculation. -| Core Vulnerabilities | The cumulative count of high-severity safety exposures identified inside child software layers. -|=== \ No newline at end of file