[RAM] Add aggs to know how many rules are snoozed (#128212)

* add aggs to know how many of snoozed rule exist * simplify + update o11y * fix tests * fix jest * bring back test
elastic · Mar 24, 2022 · a743498 · a743498
1 parent f462be7
commit a743498
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 9 deletions.
diff --git a/x-pack/plugins/alerting/common/alert.ts b/x-pack/plugins/alerting/common/alert.ts
@@ -76,6 +76,7 @@ export interface AlertAggregations {
   alertExecutionStatus: { [status: string]: number };
   ruleEnabledStatus: { enabled: number; disabled: number };
   ruleMutedStatus: { muted: number; unmuted: number };
+  ruleSnoozedStatus: { snoozed: number };
 }
 
 export interface MappedParamsProperties {

diff --git a/x-pack/plugins/alerting/server/routes/aggregate_rules.test.ts b/x-pack/plugins/alerting/server/routes/aggregate_rules.test.ts
@@ -57,6 +57,9 @@ describe('aggregateRulesRoute', () => {
         muted: 2,
         unmuted: 39,
       },
+      ruleSnoozedStatus: {
+        snoozed: 4,
+      },
     };
     rulesClient.aggregate.mockResolvedValueOnce(aggregateResult);
 
@@ -88,6 +91,9 @@ describe('aggregateRulesRoute', () => {
             "muted": 2,
             "unmuted": 39,
           },
+          "rule_snoozed_status": Object {
+            "snoozed": 4,
+          },
         },
       }
     `);
@@ -120,6 +126,9 @@ describe('aggregateRulesRoute', () => {
           muted: 2,
           unmuted: 39,
         },
+        rule_snoozed_status: {
+          snoozed: 4,
+        },
       },
     });
   });

diff --git a/x-pack/plugins/alerting/server/routes/aggregate_rules.ts b/x-pack/plugins/alerting/server/routes/aggregate_rules.ts
@@ -49,12 +49,14 @@ const rewriteBodyRes: RewriteResponseCase<AggregateResult> = ({
   alertExecutionStatus,
   ruleEnabledStatus,
   ruleMutedStatus,
+  ruleSnoozedStatus,
   ...rest
 }) => ({
   ...rest,
   rule_execution_status: alertExecutionStatus,
   rule_enabled_status: ruleEnabledStatus,
   rule_muted_status: ruleMutedStatus,
+  rule_snoozed_status: ruleSnoozedStatus,
 });
 
 export const aggregateRulesRoute = (

diff --git a/x-pack/plugins/alerting/server/rules_client/rules_client.ts b/x-pack/plugins/alerting/server/rules_client/rules_client.ts
@@ -125,6 +125,13 @@ export interface RuleAggregation {
       doc_count: number;
     }>;
   };
+  snoozed: {
+    buckets: Array<{
+      key: number;
+      key_as_string: string;
+      doc_count: number;
+    }>;
+  };
 }
 
 export interface ConstructorOptions {
@@ -191,6 +198,7 @@ export interface AggregateResult {
   alertExecutionStatus: { [status: string]: number };
   ruleEnabledStatus?: { enabled: number; disabled: number };
   ruleMutedStatus?: { muted: number; unmuted: number };
+  ruleSnoozedStatus?: { snoozed: number };
 }
 
 export interface FindResult<Params extends RuleTypeParams> {
@@ -859,6 +867,7 @@ export class RulesClient {
       );
       throw error;
     }
+
     const { filter: authorizationFilter } = authorizationTuple;
     const resp = await this.unsecuredSavedObjectsClient.find<RawRule, RuleAggregation>({
       ...options,
@@ -879,6 +888,13 @@ export class RulesClient {
         muted: {
           terms: { field: 'alert.attributes.muteAll' },
         },
+        snoozed: {
+          date_range: {
+            field: 'alert.attributes.snoozeEndTime',
+            format: 'strict_date_time',
+            ranges: [{ from: 'now' }],
+          },
+        },
       },
     });
 
@@ -894,6 +910,7 @@ export class RulesClient {
           muted: 0,
           unmuted: 0,
         },
+        ruleSnoozedStatus: { snoozed: 0 },
       };
 
       for (const key of RuleExecutionStatusValues) {
@@ -935,6 +952,11 @@ export class RulesClient {
       unmuted: mutedBuckets.find((bucket) => bucket.key === 0)?.doc_count ?? 0,
     };
 
+    const snoozedBuckets = resp.aggregations.snoozed.buckets;
+    ret.ruleSnoozedStatus = {
+      snoozed: snoozedBuckets.reduce((acc, bucket) => acc + bucket.doc_count, 0),
+    };
+
     return ret;
   }
 

diff --git a/x-pack/plugins/alerting/server/rules_client/tests/aggregate.test.ts b/x-pack/plugins/alerting/server/rules_client/tests/aggregate.test.ts
@@ -101,6 +101,17 @@ describe('aggregate()', () => {
             { key: 1, key_as_string: '1', doc_count: 3 },
           ],
         },
+        snoozed: {
+          buckets: [
+            {
+              key: '2022-03-21T20:22:01.501Z-*',
+              format: 'strict_date_time',
+              from: 1.647894121501e12,
+              from_as_string: '2022-03-21T20:22:01.501Z',
+              doc_count: 2,
+            },
+          ],
+        },
       },
     });
 
@@ -146,6 +157,9 @@ describe('aggregate()', () => {
           "muted": 3,
           "unmuted": 27,
         },
+        "ruleSnoozedStatus": Object {
+          "snoozed": 2,
+        },
       }
     `);
     expect(unsecuredSavedObjectsClient.find).toHaveBeenCalledTimes(1);
@@ -166,6 +180,13 @@ describe('aggregate()', () => {
           muted: {
             terms: { field: 'alert.attributes.muteAll' },
           },
+          snoozed: {
+            date_range: {
+              field: 'alert.attributes.snoozeEndTime',
+              format: 'strict_date_time',
+              ranges: [{ from: 'now' }],
+            },
+          },
         },
       },
     ]);
@@ -193,6 +214,13 @@ describe('aggregate()', () => {
           muted: {
             terms: { field: 'alert.attributes.muteAll' },
           },
+          snoozed: {
+            date_range: {
+              field: 'alert.attributes.snoozeEndTime',
+              format: 'strict_date_time',
+              ranges: [{ from: 'now' }],
+            },
+          },
         },
       },
     ]);

diff --git a/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx b/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx
@@ -44,6 +44,7 @@ interface RuleStatsState {
   disabled: number;
   muted: number;
   error: number;
+  snoozed: number;
 }
 
 export interface TopAlert {
@@ -90,6 +91,7 @@ function AlertsPage() {
     disabled: 0,
     muted: 0,
     error: 0,
+    snoozed: 0,
   });
 
   useEffect(() => {
@@ -111,18 +113,21 @@ function AlertsPage() {
       const response = await loadRuleAggregations({
         http,
       });
-      const { ruleExecutionStatus, ruleMutedStatus, ruleEnabledStatus } = response;
-      if (ruleExecutionStatus && ruleMutedStatus && ruleEnabledStatus) {
+      const { ruleExecutionStatus, ruleMutedStatus, ruleEnabledStatus, ruleSnoozedStatus } =
+        response;
+      if (ruleExecutionStatus && ruleMutedStatus && ruleEnabledStatus && ruleSnoozedStatus) {
         const total = Object.values(ruleExecutionStatus).reduce((acc, value) => acc + value, 0);
         const { disabled } = ruleEnabledStatus;
         const { muted } = ruleMutedStatus;
         const { error } = ruleExecutionStatus;
+        const { snoozed } = ruleSnoozedStatus;
         setRuleStats({
           ...ruleStats,
           total,
           disabled,
           muted,
           error,
+          snoozed,
         });
       }
       setRuleStatsLoading(false);
@@ -263,9 +268,9 @@ function AlertsPage() {
             data-test-subj="statDisabled"
           />,
           <EuiStat
-            title={ruleStats.muted}
+            title={ruleStats.muted + ruleStats.snoozed}
             description={i18n.translate('xpack.observability.alerts.ruleStats.muted', {
-              defaultMessage: 'Muted',
+              defaultMessage: 'Snoozed',
             })}
             color="primary"
             titleSize="xs"

diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/aggregate.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/aggregate.ts
@@ -23,7 +23,6 @@ export default function createAggregateTests({ getService }: FtrProviderContext)
       const response = await supertest.get(
         `${getUrlPrefix(Spaces.space1.id)}/internal/alerting/rules/_aggregate`
       );
-
       expect(response.status).to.eql(200);
       expect(response.body).to.eql({
         rule_enabled_status: {
@@ -42,6 +41,9 @@ export default function createAggregateTests({ getService }: FtrProviderContext)
           muted: 0,
           unmuted: 0,
         },
+        rule_snoozed_status: {
+          snoozed: 0,
+        },
       });
     });
 
@@ -96,12 +98,11 @@ export default function createAggregateTests({ getService }: FtrProviderContext)
       // calls are successful, the call to aggregate may return stale totals if called
       // too early.
       await delay(1000);
-      const reponse = await supertest.get(
+      const response = await supertest.get(
         `${getUrlPrefix(Spaces.space1.id)}/internal/alerting/rules/_aggregate`
       );
-
-      expect(reponse.status).to.eql(200);
-      expect(reponse.body).to.eql({
+      expect(response.status).to.eql(200);
+      expect(response.body).to.eql({
         rule_enabled_status: {
           disabled: 0,
           enabled: 7,
@@ -118,6 +119,9 @@ export default function createAggregateTests({ getService }: FtrProviderContext)
           muted: 0,
           unmuted: 7,
         },
+        rule_snoozed_status: {
+          snoozed: 0,
+        },
       });
     });
 
@@ -195,6 +199,9 @@ export default function createAggregateTests({ getService }: FtrProviderContext)
             muted: 0,
             unmuted: 7,
           },
+          ruleSnoozedStatus: {
+            snoozed: 0,
+          },
         });
       });
     });