You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc
+35-13Lines changed: 35 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,7 @@
4
4
= Configure aggregated Scorecard KPIs to monitor the health of multiple applications
5
5
6
6
[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.
10
8
11
9
.Prerequisites
12
10
@@ -16,22 +14,46 @@ Monitoring collective health across a portfolio allows team leads and managers t
16
14
17
15
.Procedure
18
16
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.
20
20
+
21
21
[source,yaml]
22
22
----
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}
23
36
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 }
28
50
----
29
51
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.
31
53
32
54
.. Open your RBAC policy file, typically `rbac-policy.csv`.
33
55
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.
. 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.
47
67
48
68
.. Click an aggregated KPI tile, such as *Critical Jira Issues*.
49
69
50
70
.. 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