Implemented Alerting health status pusher by using task manager and status pooler for Kibana status plugins 'kibanahost/api/status'

x-pack/plugins/alerts/common/alert.ts

@@ -20,13 +20,12 @@ export interface IntervalSchedule extends SavedObjectAttributes {
 export const AlertExecutionStatusValues = ['ok', 'active', 'error', 'pending', 'unknown'] as const;
 export type AlertExecutionStatuses = typeof AlertExecutionStatusValues[number];
 
-export const AlertExecutionStatusErrorReasonValues = [
-  'read',
-  'decrypt',
-  'execute',
-  'unknown',
-] as const;
-export type AlertExecutionStatusErrorReasons = typeof AlertExecutionStatusErrorReasonValues[number];
+export enum AlertExecutionStatusErrorReasons {
+  Read = 'read',
+  Decrypt = 'decrypt',
+  Execute = 'execute',
+  Unknown = 'unknown',
+}
 
 export interface AlertExecutionStatus {
   status: AlertExecutionStatuses;
@@ -74,3 +73,24 @@ export interface Alert {
 }
 
 export type SanitizedAlert = Omit<Alert, 'apiKey'>;
+
+export enum HealthStatus {
+  OK = 'ok',
+  Warning = 'warn',
+  Error = 'error',
+}
+
+export interface AlertsHealth {
+  decryptionHealth: {
+    status: HealthStatus;
+    timestamp: string;
+  };
+  executionHealth: {
+    status: HealthStatus;
+    timestamp: string;
+  };
+  readHealth: {
+    status: HealthStatus;
+    timestamp: string;
+  };
+}

x-pack/plugins/alerts/common/index.ts

@@ -4,6 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { AlertsHealth } from './alert';
+
 export * from './alert';
 export * from './alert_type';
 export * from './alert_instance';
@@ -19,6 +21,7 @@ export interface ActionGroup {
 export interface AlertingFrameworkHealth {
   isSufficientlySecure: boolean;
   hasPermanentEncryptionKey: boolean;
+  alertingFrameworkHeath: AlertsHealth;
 }
 
 export const BASE_ALERT_API_PATH = '/api/alerts';

x-pack/plugins/alerts/server/config.test.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { configSchema } from './config';
+
+describe('config validation', () => {
+  test('alerts defaults', () => {
+    const config: Record<string, unknown> = {};
+    expect(configSchema.validate(config)).toMatchInlineSnapshot(`
+      Object {
+        "healthCheck": Object {
+          "interval": "60m",
+        },
+      }
+    `);
+  });
+});

x-pack/plugins/alerts/server/config.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { schema, TypeOf } from '@kbn/config-schema';
+import { validateDurationSchema } from './lib';
+
+export const configSchema = schema.object({
+  healthCheck: schema.object({
+    interval: schema.string({ validate: validateDurationSchema, defaultValue: '60m' }),
+  }),
+});
+
+export type AlertsConfig = TypeOf<typeof configSchema>;

x-pack/plugins/alerts/server/health/get_health.test.ts

@@ -0,0 +1,221 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { savedObjectsRepositoryMock } from '../../../../../src/core/server/mocks';
+import { AlertExecutionStatusErrorReasons, HealthStatus } from '../types';
+import { getHealth } from './get_health';
+
+const savedObjectsRepository = savedObjectsRepositoryMock.create();
+
+describe('getHealth()', () => {
+  test('return true if some of alerts has a decryption error', async () => {
+    const lastExecutionDateError = new Date().toISOString();
+    const lastExecutionDate = new Date().toISOString();
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 1,
+      per_page: 1,
+      page: 1,
+      saved_objects: [
+        {
+          id: '1',
+          type: 'alert',
+          attributes: {
+            alertTypeId: 'myType',
+            schedule: { interval: '10s' },
+            params: {
+              bar: true,
+            },
+            createdAt: new Date().toISOString(),
+            actions: [
+              {
+                group: 'default',
+                actionRef: 'action_0',
+                params: {
+                  foo: true,
+                },
+              },
+            ],
+            executionStatus: {
+              status: 'error',
+              lastExecutionDate: lastExecutionDateError,
+              error: {
+                reason: AlertExecutionStatusErrorReasons.Decrypt,
+                message: 'Failed decrypt',
+              },
+            },
+          },
+          score: 1,
+          references: [
+            {
+              name: 'action_0',
+              type: 'action',
+              id: '1',
+            },
+          ],
+        },
+      ],
+    });
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 0,
+      per_page: 10,
+      page: 1,
+      saved_objects: [],
+    });
+
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 0,
+      per_page: 10,
+      page: 1,
+      saved_objects: [],
+    });
+
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 1,
+      per_page: 1,
+      page: 1,
+      saved_objects: [
+        {
+          id: '2',
+          type: 'alert',
+          attributes: {
+            alertTypeId: 'myType',
+            schedule: { interval: '1s' },
+            params: {
+              bar: true,
+            },
+            createdAt: new Date().toISOString(),
+            actions: [],
+            executionStatus: {
+              status: 'ok',
+              lastExecutionDate,
+            },
+          },
+          score: 1,
+          references: [],
+        },
+      ],
+    });
+    const result = await getHealth(savedObjectsRepository);
+    expect(result).toStrictEqual({
+      executionHealth: {
+        status: HealthStatus.OK,
+        timestamp: lastExecutionDate,
+      },
+      readHealth: {
+        status: HealthStatus.OK,
+        timestamp: lastExecutionDate,
+      },
+      decryptionHealth: {
+        status: HealthStatus.Warning,
+        timestamp: lastExecutionDateError,
+      },
+    });
+    expect(savedObjectsRepository.find).toHaveBeenCalledTimes(4);
+  });
+
+  test('return false if no alerts with a decryption error', async () => {
+    const lastExecutionDateError = new Date().toISOString();
+    const lastExecutionDate = new Date().toISOString();
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 0,
+      per_page: 10,
+      page: 1,
+      saved_objects: [],
+    });
+
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 1,
+      per_page: 1,
+      page: 1,
+      saved_objects: [
+        {
+          id: '1',
+          type: 'alert',
+          attributes: {
+            alertTypeId: 'myType',
+            schedule: { interval: '10s' },
+            params: {
+              bar: true,
+            },
+            createdAt: new Date().toISOString(),
+            actions: [
+              {
+                group: 'default',
+                actionRef: 'action_0',
+                params: {
+                  foo: true,
+                },
+              },
+            ],
+            executionStatus: {
+              status: 'error',
+              lastExecutionDate: lastExecutionDateError,
+              error: {
+                reason: AlertExecutionStatusErrorReasons.Execute,
+                message: 'Failed',
+              },
+            },
+          },
+          score: 1,
+          references: [
+            {
+              name: 'action_0',
+              type: 'action',
+              id: '1',
+            },
+          ],
+        },
+      ],
+    });
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 0,
+      per_page: 10,
+      page: 1,
+      saved_objects: [],
+    });
+
+    savedObjectsRepository.find.mockResolvedValueOnce({
+      total: 1,
+      per_page: 1,
+      page: 1,
+      saved_objects: [
+        {
+          id: '2',
+          type: 'alert',
+          attributes: {
+            alertTypeId: 'myType',
+            schedule: { interval: '1s' },
+            params: {
+              bar: true,
+            },
+            createdAt: new Date().toISOString(),
+            actions: [],
+            executionStatus: {
+              status: 'ok',
+              lastExecutionDate,
+            },
+          },
+          score: 1,
+          references: [],
+        },
+      ],
+    });
+    const result = await getHealth(savedObjectsRepository);
+    expect(result).toStrictEqual({
+      executionHealth: {
+        status: HealthStatus.Warning,
+        timestamp: lastExecutionDateError,
+      },
+      readHealth: {
+        status: HealthStatus.OK,
+        timestamp: lastExecutionDate,
+      },
+      decryptionHealth: {
+        status: HealthStatus.OK,
+        timestamp: lastExecutionDate,
+      },
+    });
+  });
+});