From 74299ff4bb124cc43a42b16383038163cc42cd46 Mon Sep 17 00:00:00 2001 From: Nizamudeen A Date: Tue, 23 Mar 2021 12:40:46 +0530 Subject: [PATCH] mgr/dashboard: Fix for alert notification message being undefined Prometheus alert notification message in the dashboard always comes up as undefined. Its because we were showing the alert.summary instead of alert.description for displaying the message. I couldn't find the summary field in the ceph_default_alerts.yml file. So removed all the Summary fields from the dashboard code. Fixes: https://tracker.ceph.com/issues/49342 Signed-off-by: Nizamudeen A (cherry picked from commit 2921b2e9a939e1ad52b07327fdf84885568384b9) --- .../frontend/src/app/shared/models/prometheus-alerts.ts | 3 +-- .../app/shared/services/prometheus-alert-formatter.spec.ts | 6 +++--- .../src/app/shared/services/prometheus-alert-formatter.ts | 4 ++-- .../mgr/dashboard/frontend/src/testing/unit-test-helper.ts | 4 ++-- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/models/prometheus-alerts.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/models/prometheus-alerts.ts index f5e8f850b15..1239dcccdfe 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/models/prometheus-alerts.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/models/prometheus-alerts.ts @@ -7,7 +7,6 @@ export class PrometheusAlertLabels { class Annotations { description: string; - summary: string; } class CommonAlertmanagerAlert { @@ -80,6 +79,6 @@ export class PrometheusCustomAlert { status: 'resolved' | 'unprocessed' | 'active' | 'suppressed'; name: string; url: string; - summary: string; + description: string; fingerprint?: string | boolean; } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.spec.ts index dfd43778f73..04e234de593 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.spec.ts @@ -55,7 +55,7 @@ describe('PrometheusAlertFormatter', () => { { status: 'active', name: 'Something', - summary: 'Something is active', + description: 'Something is active', url: 'http://Something', fingerprint: 'Something' } as PrometheusCustomAlert @@ -70,7 +70,7 @@ describe('PrometheusAlertFormatter', () => { fingerprint: false, status: 'active', name: 'Something', - summary: 'Something is firing', + description: 'Something is firing', url: 'http://Something' } as PrometheusCustomAlert ]); @@ -81,7 +81,7 @@ describe('PrometheusAlertFormatter', () => { const alert: PrometheusCustomAlert = { status: 'active', name: 'Some alert', - summary: 'Some alert is active', + description: 'Some alert is active', url: 'http://some-alert', fingerprint: '42' }; diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.ts index 58c084bb0cd..61f9ed8aa11 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/prometheus-alert-formatter.ts @@ -33,7 +33,7 @@ export class PrometheusAlertFormatter { : this.getPrometheusNotificationStatus(alert as AlertmanagerNotificationAlert), name: alert.labels.alertname, url: alert.generatorURL, - summary: alert.annotations.summary, + description: alert.annotations.description, fingerprint: _.isObject(alert.status) && (alert as AlertmanagerAlert).fingerprint }; }), @@ -53,7 +53,7 @@ export class PrometheusAlertFormatter { return new CdNotificationConfig( this.formatType(alert.status), `${alert.name} (${alert.status})`, - this.appendSourceLink(alert, alert.summary), + this.appendSourceLink(alert, alert.description), undefined, 'Prometheus' ); diff --git a/src/pybind/mgr/dashboard/frontend/src/testing/unit-test-helper.ts b/src/pybind/mgr/dashboard/frontend/src/testing/unit-test-helper.ts index 81047f90637..a950557d939 100644 --- a/src/pybind/mgr/dashboard/frontend/src/testing/unit-test-helper.ts +++ b/src/pybind/mgr/dashboard/frontend/src/testing/unit-test-helper.ts @@ -297,7 +297,7 @@ export class PrometheusHelper { severity: 'someSeverity' }, annotations: { - summary: `${name} is ${state}` + description: `${name} is ${state}` }, generatorURL: `http://${name}`, startsAt: new Date(new Date('2022-02-22').getTime() * timeMultiplier).toString() @@ -311,7 +311,7 @@ export class PrometheusHelper { alertname: name }, annotations: { - summary: `${name} is ${status}` + description: `${name} is ${status}` }, generatorURL: `http://${name}` } as AlertmanagerNotificationAlert; -- 2.47.3