[Synthetics] copy alert state to alert context and implement alert recovery

x-pack/plugins/synthetics/common/translations.ts

@@ -28,11 +28,23 @@ export const MonitorStatusTranslations = {
       defaultMessage:
         'Monitor {monitorName} with url {monitorUrl} from {observerLocation} {statusMessage} The latest error message is {latestErrorMessage}',
       values: {
-        monitorName: '{{state.monitorName}}',
-        monitorUrl: '{{{state.monitorUrl}}}',
-        statusMessage: '{{{state.statusMessage}}}',
-        latestErrorMessage: '{{{state.latestErrorMessage}}}',
-        observerLocation: '{{state.observerLocation}}',
+        monitorName: '{{context.monitorName}}',
+        monitorUrl: '{{{context.monitorUrl}}}',
+        statusMessage: '{{{context.statusMessage}}}',
+        latestErrorMessage: '{{{context.latestErrorMessage}}}',
+        observerLocation: '{{context.observerLocation}}',
+      },
+    }
+  ),
+  defaultRecoveryMessage: i18n.translate(
+    'xpack.synthetics.alerts.monitorStatus.defaultRecoveryMessage',
+    {
+      defaultMessage:
+        'Alert for monitor {monitorName} with url {monitorUrl} from {observerLocation} has recovered',
+      values: {
+        monitorName: '{{context.monitorName}}',
+        monitorUrl: '{{{context.monitorUrl}}}',
+        observerLocation: '{{context.observerLocation}}',
       },
     }
   ),
@@ -46,13 +58,19 @@ export const MonitorStatusTranslations = {
 
 export const TlsTranslations = {
   defaultActionMessage: i18n.translate('xpack.synthetics.alerts.tls.defaultActionMessage', {
-    defaultMessage: `Detected TLS certificate {commonName} from issuer {issuer} is {status}. Certificate {summary}
-`,
+    defaultMessage: `Detected TLS certificate {commonName} from issuer {issuer} is {status}. Certificate {summary}`,
     values: {
-      commonName: '{{state.commonName}}',
-      issuer: '{{state.issuer}}',
-      summary: '{{state.summary}}',
-      status: '{{state.status}}',
+      commonName: '{{context.commonName}}',
+      issuer: '{{context.issuer}}',
+      summary: '{{context.summary}}',
+      status: '{{context.status}}',
+    },
+  }),
+  defaultRecoveryMessage: i18n.translate('xpack.synthetics.alerts.tls.defaultRecoveryMessage', {
+    defaultMessage: `Alert for TLS certificate {commonName} from issuer {issuer} has recovered`,
+    values: {
+      commonName: '{{context.commonName}}',
+      issuer: '{{context.issuer}}',
     },
   }),
   name: i18n.translate('xpack.synthetics.alerts.tls.clientName', {
@@ -103,14 +121,27 @@ export const DurationAnomalyTranslations = {
       defaultMessage: `Abnormal ({severity} level) response time detected on {monitor} with url {monitorUrl} at {anomalyStartTimestamp}. Anomaly severity score is {severityScore}.
 Response times as high as {slowestAnomalyResponse} have been detected from location {observerLocation}. Expected response time is {expectedResponseTime}.`,
       values: {
-        severity: '{{state.severity}}',
-        anomalyStartTimestamp: '{{state.anomalyStartTimestamp}}',
-        monitor: '{{state.monitor}}',
-        monitorUrl: '{{{state.monitorUrl}}}',
-        slowestAnomalyResponse: '{{state.slowestAnomalyResponse}}',
-        expectedResponseTime: '{{state.expectedResponseTime}}',
-        severityScore: '{{state.severityScore}}',
-        observerLocation: '{{state.observerLocation}}',
+        severity: '{{context.severity}}',
+        anomalyStartTimestamp: '{{context.anomalyStartTimestamp}}',
+        monitor: '{{context.monitor}}',
+        monitorUrl: '{{{context.monitorUrl}}}',
+        slowestAnomalyResponse: '{{context.slowestAnomalyResponse}}',
+        expectedResponseTime: '{{context.expectedResponseTime}}',
+        severityScore: '{{context.severityScore}}',
+        observerLocation: '{{context.observerLocation}}',
+      },
+    }
+  ),
+  defaultRecoveryMessage: i18n.translate(
+    'xpack.synthetics.alerts.durationAnomaly.defaultRecoveryMessage',
+    {
+      defaultMessage: `Alert for abnormal ({severity} level) response time detected on monitor {monitor} with url {monitorUrl} from location {observerLocation} at {anomalyStartTimestamp} has recovered`,
+      values: {
+        severity: '{{context.severity}}',
+        anomalyStartTimestamp: '{{context.anomalyStartTimestamp}}',
+        monitor: '{{context.monitor}}',
+        monitorUrl: '{{{context.monitorUrl}}}',
+        observerLocation: '{{context.observerLocation}}',
       },
     }
   ),

x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/duration_anomaly.tsx

@@ -16,7 +16,7 @@ import { getMonitorRouteFromMonitorId } from '../../../../common/utils/get_monit
 import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts';
 import { DurationAnomalyTranslations } from '../../../../common/translations';
 
-const { defaultActionMessage, description } = DurationAnomalyTranslations;
+const { defaultActionMessage, defaultRecoveryMessage, description } = DurationAnomalyTranslations;
 const DurationAnomalyAlert = React.lazy(() => import('./lazy_wrapper/duration_anomaly'));
 
 export const initDurationAnomalyAlertType: AlertTypeInitializer = ({
@@ -34,6 +34,7 @@ export const initDurationAnomalyAlertType: AlertTypeInitializer = ({
   description,
   validate: () => ({ errors: {} }),
   defaultActionMessage,
+  defaultRecoveryMessage,
   requiresAppContext: true,
   format: ({ fields }) => ({
     reason: fields[ALERT_REASON] || '',

x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.test.ts

@@ -202,7 +202,8 @@ describe('monitor status alert type', () => {
       })
     ).toMatchInlineSnapshot(`
       Object {
-        "defaultActionMessage": "Monitor {{state.monitorName}} with url {{{state.monitorUrl}}} from {{state.observerLocation}} {{{state.statusMessage}}} The latest error message is {{{state.latestErrorMessage}}}",
+        "defaultActionMessage": "Monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} {{{context.statusMessage}}} The latest error message is {{{context.latestErrorMessage}}}",
+        "defaultRecoveryMessage": "Alert for monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} has recovered",
         "description": "Alert when a monitor is down or an availability threshold is breached.",
         "documentationUrl": [Function],
         "format": [Function],

x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.tsx

@@ -23,7 +23,7 @@ import { getMonitorRouteFromMonitorId } from '../../../../common/utils/get_monit
 import { MonitorStatusTranslations } from '../../../../common/translations';
 import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts';
 
-const { defaultActionMessage, description } = MonitorStatusTranslations;
+const { defaultActionMessage, defaultRecoveryMessage, description } = MonitorStatusTranslations;
 
 const MonitorStatusAlert = React.lazy(() => import('./lazy_wrapper/monitor_status'));
 
@@ -54,6 +54,7 @@ export const initMonitorStatusAlertType: AlertTypeInitializer = ({
     return validateFunc ? validateFunc(ruleParams) : ({} as ValidationResult);
   },
   defaultActionMessage,
+  defaultRecoveryMessage,
   requiresAppContext: false,
   format: ({ fields }) => ({
     reason: fields[ALERT_REASON] || '',

x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls.tsx

@@ -14,7 +14,7 @@ import { AlertTypeInitializer } from '.';
 
 import { CERTIFICATES_ROUTE } from '../../../../common/constants/ui';
 
-const { defaultActionMessage, description } = TlsTranslations;
+const { defaultActionMessage, defaultRecoveryMessage, description } = TlsTranslations;
 const TLSAlert = React.lazy(() => import('./lazy_wrapper/tls_alert'));
 export const initTlsAlertType: AlertTypeInitializer = ({
   core,
@@ -29,6 +29,7 @@ export const initTlsAlertType: AlertTypeInitializer = ({
   description,
   validate: () => ({ errors: {} }),
   defaultActionMessage,
+  defaultRecoveryMessage,
   requiresAppContext: false,
   format: ({ fields }) => ({
     reason: fields[ALERT_REASON] || '',

x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.test.ts

@@ -50,7 +50,7 @@ describe('Alert Actions factory', () => {
             eventAction: 'trigger',
             severity: 'error',
             summary:
-              'Monitor {{state.monitorName}} with url {{{state.monitorUrl}}} from {{state.observerLocation}} {{{state.statusMessage}}} The latest error message is {{{state.latestErrorMessage}}}',
+              'Monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} {{{context.statusMessage}}} The latest error message is {{{context.latestErrorMessage}}}',
           },
           id: 'f2a3b195-ed76-499a-805d-82d24d4eeba9',
         },
@@ -75,7 +75,7 @@ describe('Alert Actions factory', () => {
           eventAction: 'trigger',
           severity: 'error',
           summary:
-            'Monitor {{state.monitorName}} with url {{{state.monitorUrl}}} from {{state.observerLocation}} {{{state.statusMessage}}} The latest error message is {{{state.latestErrorMessage}}}',
+            'Monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} {{{context.statusMessage}}} The latest error message is {{{context.latestErrorMessage}}}',
         },
       },
     ]);
@@ -93,7 +93,7 @@ describe('Alert Actions factory', () => {
             eventAction: 'trigger',
             severity: 'error',
             summary:
-              'Monitor {{state.monitorName}} with url {{{state.monitorUrl}}} from {{state.observerLocation}} {{{state.statusMessage}}} The latest error message is {{{state.latestErrorMessage}}}',
+              'Monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} {{{context.statusMessage}}} The latest error message is {{{context.latestErrorMessage}}}',
           },
           id: 'f2a3b195-ed76-499a-805d-82d24d4eeba9',
         },
@@ -118,7 +118,7 @@ describe('Alert Actions factory', () => {
           eventAction: 'trigger',
           severity: 'error',
           summary:
-            'Monitor {{state.monitorName}} with url {{{state.monitorUrl}}} from {{state.observerLocation}} {{{state.statusMessage}}} The latest error message is {{{state.latestErrorMessage}}}',
+            'Monitor {{context.monitorName}} with url {{{context.monitorUrl}}} from {{context.observerLocation}} {{{context.statusMessage}}} The latest error message is {{{context.latestErrorMessage}}}',
         },
       },
     ]);

x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.ts

@@ -127,11 +127,11 @@ function getIndexActionParams(selectedMonitor: Ping, recovery = false): IndexAct
     return {
       documents: [
         {
-          monitorName: '{{state.monitorName}}',
-          monitorUrl: '{{{state.monitorUrl}}}',
+          monitorName: '{{context.monitorName}}',
+          monitorUrl: '{{{context.monitorUrl}}}',
           statusMessage: getRecoveryMessage(selectedMonitor),
           latestErrorMessage: '',
-          observerLocation: '{{state.observerLocation}}',
+          observerLocation: '{{context.observerLocation}}',
         },
       ],
       indexOverride: null,
@@ -140,11 +140,11 @@ function getIndexActionParams(selectedMonitor: Ping, recovery = false): IndexAct
   return {
     documents: [
       {
-        monitorName: '{{state.monitorName}}',
-        monitorUrl: '{{{state.monitorUrl}}}',
-        statusMessage: '{{{state.statusMessage}}}',
-        latestErrorMessage: '{{{state.latestErrorMessage}}}',
-        observerLocation: '{{state.observerLocation}}',
+        monitorName: '{{context.monitorName}}',
+        monitorUrl: '{{{context.monitorUrl}}}',
+        statusMessage: '{{{context.statusMessage}}}',
+        latestErrorMessage: '{{{context.latestErrorMessage}}}',
+        observerLocation: '{{context.observerLocation}}',
       },
     ],
     indexOverride: null,

x-pack/plugins/synthetics/server/lib/alerts/common.ts

@@ -8,6 +8,7 @@
 import { isRight } from 'fp-ts/lib/Either';
 import Mustache from 'mustache';
 import { IBasePath } from '@kbn/core/server';
+import { RuleExecutorServices } from '@kbn/alerting-plugin/server';
 import { UptimeCommonState, UptimeCommonStateType } from '../../../common/runtime_types';
 
 export type UpdateUptimeAlertState = (
@@ -59,9 +60,17 @@ export const updateState: UpdateUptimeAlertState = (state, isTriggeredNow) => {
 };
 
 export const generateAlertMessage = (messageTemplate: string, fields: Record<string, any>) => {
-  return Mustache.render(messageTemplate, { state: { ...fields } });
+  return Mustache.render(messageTemplate, { context: { ...fields }, state: { ...fields } });
 };
 export const getViewInAppUrl = (relativeViewInAppUrl: string, basePath: IBasePath) =>
   basePath.publicBaseUrl
     ? new URL(basePath.prepend(relativeViewInAppUrl), basePath.publicBaseUrl).toString()
     : relativeViewInAppUrl;
+
+export const setRecoveredAlertsContext = (alertFactory: RuleExecutorServices['alertFactory']) => {
+  const { getRecoveredAlerts } = alertFactory.done();
+  for (const alert of getRecoveredAlerts()) {
+    const state = alert.getState();
+    alert.setContext(state);
+  }
+};