Skip to content

Commit 775eb37

Browse files
committed
RHIDP-12524: updated PR after discussion with Patrick, and using claude to run style checks
1 parent cbaeba8 commit 775eb37

1 file changed

Lines changed: 35 additions & 13 deletions

File tree

modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
= Configure aggregated Scorecard KPIs to monitor the health of multiple applications
55

66
[role="_abstract"]
7-
Configure the {product} Scorecard plugin to enable drill-down capabilities, allowing users to investigate the specific catalog entities and metrics that contribute to aggregated KPI scores.
8-
9-
Monitoring collective health across a portfolio allows team leads and managers to identify trends. By configuring drill-downs, users can quickly analyze which specific applications are failing or require attention.
7+
Configure drill-downs to quickly identify trends across your application portfolio and analyze which specific applications require attention. Monitoring collective health across a portfolio allows team leads and managers to identify patterns, prioritize issues, and take action on applications that are failing or need intervention.
108

119
.Prerequisites
1210

@@ -16,22 +14,46 @@ Monitoring collective health across a portfolio allows team leads and managers t
1614

1715
.Procedure
1816

19-
. Define the metric ID for drill-down in your `app-config.yaml` file. Drill-downs are metric-scoped. Even when clicking an aggregated KPI, the system requires the underlying `metricId` to query the catalog for related entities.
17+
. Define the metric ID for drill-down in your `app-config.yaml` file.
18+
+
19+
Drill-downs are metric-scoped. Even when you click an aggregated KPI, the system requires the underlying `metricId` to query the catalog for related entities.
2020
+
2121
[source,yaml]
2222
----
23+
proxy:
24+
'/jira/api':
25+
target: ${JIRA_URL}
26+
headers:
27+
Authorization: ${JIRA_TOKEN}
28+
Accept: 'application/json'
29+
Content-Type: 'application/json'
30+
X-Atlassian-Token: 'nocheck'
31+
User-Agent: 'MY-UA-STRING'
32+
jira:
33+
product: cloud
34+
baseUrl: ${JIRA_URL}
35+
token: ${JIRA_TOKEN}
2336
scorecard:
24-
kpis:
25-
- id: criticalJiraIssuesKpi
26-
metricId: jira.critical_issues
27-
type: average
37+
aggregationKPIs:
38+
openIssuesKpi:
39+
title: Jira Open Issues KPI
40+
type: statusGrouped
41+
description: This KPI provides information about Jira open issues grouped by status.
42+
metricId: jira.open_issues # must match the `plugins.jira.open_issues` section
43+
plugins:
44+
jira:
45+
open_issues:
46+
schedule:
47+
frequency: { minutes: 5 }
48+
timeout: { minutes: 10 }
49+
initialDelay: { seconds: 10 }
2850
----
2951

30-
. Assign the required Role-Based Access Control (RBAC) permissions to the relevant user roles.
52+
. Configure Role-Based Access Control (RBAC) permissions for the relevant user roles to enable scorecard access.
3153

3254
.. Open your RBAC policy file, typically `rbac-policy.csv`.
3355

34-
.. Add or verify that users have permission to read both scorecard metrics and catalog entities.
56+
.. Add the following permission to read both scorecard metrics and catalog entities.
3557
+
3658
[source,csv]
3759
----
@@ -41,10 +63,10 @@ p, role:default/team_lead, catalog.entity, read, allow
4163

4264
.Verification
4365

44-
. Ensure your Scorecard backend supports the `/metrics/:metricId/catalog/aggregations/entities` endpoint by checking that you are using the latest version of the {product-very-short} plugins.
45-
46-
.. Navigate to the {product} Home Page and verify the drill-down action.
66+
.. Navigate to the {product} Home Page.
4767

4868
.. Click an aggregated KPI tile, such as *Critical Jira Issues*.
4969

5070
.. Verify that a list of individual catalog entities appears, showing the components contributing to that aggregate score.
71+
+
72+
If the list does not appear, ensure you are using the latest version of the {product-very-short} plugins.

0 commit comments

Comments
 (0)