Skip to content

Commit f5376f2

Browse files
rh-tokeeferh-tokeefe
committed
RHIDP-12524: edits from dev review. added new topics
1 parent e59b743 commit f5376f2

5 files changed

Lines changed: 168 additions & 1 deletion

File tree

‎assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,14 @@ include::../modules/observability_evaluate-project-health-using-scorecards/con-a
1414

1515
include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc[leveloffset=+1]
1616

17-
include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1]
17+
include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1]
18+
19+
include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc[leveloffset=+1]
1820

1921
include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1]
2022

23+
include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1]
24+
2125
include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1]
2226

2327
include::../modules/observability_evaluate-project-health-using-scorecards/proc-schedule-metrics-to-avoid-api-limits.adoc[leveloffset=+1]
@@ -29,5 +33,10 @@ include::../modules/observability_evaluate-project-health-using-scorecards/ref-e
2933
include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-aggregated-metrics-for-owned-entities.adoc[leveloffset=+1]
3034

3135
include::../modules/observability_evaluate-project-health-using-scorecards/ref-available-metric-data-for-entities.adoc[leveloffset=+1]
36+
37+
include::../modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc[leveloffset=+1]
38+
39+
include::../modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc[leveloffset=+1]
40+
3241
ifdef::parent-context[:context: {parent-context}]
3342
ifndef::parent-context[:!context:]

‎modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="configure-a-default-scorecard-aggregation-card_{context}"]
4+
= Configure a default scorecard aggregation card
5+
6+
[role="_abstract"]
7+
Add a standard scorecard summary card to your homepage using default, out-of-the-box configurations.
8+
9+
.Prerequisites
10+
11+
* The scorecard plugin is installed and configured in your {product} instance.
12+
13+
* You have administrator permissions to update application configuration files.
14+
15+
.Procedure
16+
. Open your dynamic plugin configuration file.
17+
18+
. Navigate to your scorecard card block under the `home.page/cards` mount point.
19+
20+
. Update the configuration to use the `aggregationId` property with an established system metric name:
21+
+
22+
[source,yaml]
23+
----
24+
- mountPoint: home.page/cards
25+
importName: ScorecardHomepageCard
26+
config:
27+
props:
28+
aggregationId: "github.open_prs"
29+
layouts:
30+
xl: { w: 3, h: 6, x: 3 }
31+
lg: { w: 4, h: 6, x: 4 }
32+
md: { w: 6, h: 6, x: 6 }
33+
sm: { w: 12, h: 6 }
34+
xs: { w: 12, h: 6 }
35+
xxs: { w: 12, h: 6 }
36+
----
37+
38+
. Save the modified configuration file and restart your {product} instance.
39+
40+
.Verification
41+
* Access your {roduct-short} homepage interface.
42+
43+
* Verify that the standard scorecard summary card displays with default metrics.

‎modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="configure-an-aggregation-card-with-a-custom-tracking-type_{context}"]
4+
= Configure an aggregation card with a custom tracking type
5+
6+
[role="_abstract"]
7+
Configure a scorecard aggregation card to display status-grouped metric counts or weighted portfolio scores across multiple components.
8+
9+
.Prerequisites
10+
11+
* The scorecard plugin is installed and configured in your {product} instance.
12+
13+
* You have identified the source metric provider and group from the Software Catalog you wish to aggregate.
14+
15+
.Procedure
16+
. Open your `app-config.yaml` file.
17+
18+
. Navigate to the `scorecard` section and define your backend Key Performance Indicator (KPI) map within an `aggregationKPIs` block:
19+
+
20+
[source,yaml]
21+
----
22+
scorecard:
23+
aggregationKPIs:
24+
team-alpha-bugs:
25+
title: "Team Alpha Bug KPI"
26+
description: "Portfolio bug counts grouped by status threshold"
27+
type: statusGrouped
28+
metricId: jira.open_issues
29+
----
30+
31+
. Open your dynamic plugin configuration file.
32+
33+
. Reference your custom aggregation ID inside the homepage card properties block under the `home.page/cards` mount point:
34+
+
35+
[source,yaml]
36+
----
37+
- mountPoint: home.page/cards
38+
importName: ScorecardHomepageCard
39+
config:
40+
props:
41+
aggregationId: "team-alpha-bugs"
42+
layouts:
43+
xl: { w: 3, h: 6 }
44+
lg: { w: 4, h: 6 }
45+
md: { w: 6, h: 6 }
46+
sm: { w: 12, h: 6 }
47+
xs: { w: 12, h: 6 }
48+
xxs: { w: 12, h: 6 }
49+
----
50+
+
51+
where:
52+
+
53+
`scorecard.aggregationKPIs`:: Map of KPI keys to KPI definitions. Each key is an aggregation ID.
54+
`title`:: Title shown for the KPI.
55+
`description`:: Short description of the KPI.
56+
`type`:: Aggregation strategy. Use `statusGrouped` for counts per threshold status, or `average` for a weighted portfolio score.
57+
`metricId`:: Metric provider ID.
58+
59+
. Save the modified configuration files and restart your {product} instance.
60+
61+
.Verification
62+
63+
* Access your {product} interface.
64+
65+
* Verify that the custom scorecard summary card displays with your defined title and calculated values.

‎modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
[id="ref-scorecard-card-configuration-parameters_{context}"]
4+
= Scorecard card configuration parameters
5+
6+
[role="_abstract"]
7+
Parameters for application settings and dynamic plugin files used to manage homepage visualizations and portfolio data logic.
8+
9+
== Dynamic plugin properties
10+
[cols="1,3",options="header"]
11+
|===
12+
|Property |Description
13+
|`aggregationId` |The target identifier for the homepage visualization block. Accepts a default system metric name string or a custom KPI key mapped in your core settings.
14+
|`metricId` |[Deprecated] Legacy identifier for the source metric string. Supported for backwards compatibility but scheduled for removal in a future release. Replace with `aggregationId`.
15+
|===
16+
17+
== Application configuration properties (`scorecard.aggregationKPIs`)
18+
[cols="1,3",options="header"]
19+
|===
20+
|Property |Description
21+
|`title` |The primary textual label rendered on the header block of the homepage card.
22+
|`description` |A brief text string summarizing the target scope of the KPI.
23+
|`type` |The structural tracking strategy. Specify `statusGrouped` to return independent numerical entity counts per threshold status layer, or specify `average` to calculate a single weighted portfolio score.
24+
|`metricId` |The unique provider identifier mapping to the individual source plugin collection layer, such as `jira.open_issues` or `github.open_prs`.
25+
|===

‎modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
[id="scorecard-plugin-rest-api-endpoints-and-parameters_{context}"]
4+
= Scorecard plugin REST API endpoints and parameters
5+
6+
[role="_abstract"]
7+
REST API endpoints for the scorecard plugin used to fetch portfolio evaluations and component summaries.
8+
9+
== Supported REST API endpoints
10+
[cols="1,2,1",options="header"]
11+
|===
12+
|Method and endpoint |Description |Status
13+
|`GET /metrics` |Retrieves all base metrics collected by the plugin environment. |Active
14+
|`GET /aggregations/:aggregationId` |Retrieves calculated summary parameters for a targeted portfolio grouping definition. |Active
15+
|`GET /metrics/:metricId/catalog/aggregations` |Retrieves aggregated summary parameters for a specified entity grouping path. |Deprecated
16+
|===
17+
18+
[IMPORTANT]
19+
====
20+
The endpoint `GET /metrics/:metricId/catalog/aggregations` is deprecated. Update your platform integrations to use the new route path structure: `GET /aggregations/:aggregationId`.
21+
====
22+
23+
== API parameter definitions
24+
`aggregationId`:: The unique identification key tracking a targeted scorecard summary layout block.
25+
`metricId`:: The unique provider key tracking an individual metrics collection channel source layer.

0 commit comments

Comments
 (0)