[8.17] [Synthetics] Fix to handle ops genie as default connector !! (#…

…201923) (#202572) # Backport This will backport the following commits from `main` to `8.17`: - [[Synthetics] Fix to handle ops genie as default connector !! (#201923)](#201923)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Shahzad <[email protected]>
elastic · Dec 2, 2024 · 09f4e91 · 09f4e91
1 parent 213a96d
commit 09f4e91
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 1 deletion.
diff --git a/x-pack/plugins/observability_solution/synthetics/common/rules/alert_actions.test.ts b/x-pack/plugins/observability_solution/synthetics/common/rules/alert_actions.test.ts
@@ -291,4 +291,77 @@ describe('Alert Actions factory', () => {
       },
     ]);
   });
+
+  it('generate expected action for email opsgenie connector', async () => {
+    const resp = populateAlertActions({
+      groupId: SYNTHETICS_MONITOR_STATUS.id,
+      defaultActions: [
+        {
+          frequency: {
+            notifyWhen: 'onActionGroupChange',
+            summary: false,
+            throttle: null,
+          },
+          actionTypeId: '.opsgenie',
+          group: 'xpack.synthetics.alerts.actionGroups.monitorStatus',
+          params: {},
+          id: 'f2a3b195-ed76-499a-805d-82d24d4eeba9',
+        },
+      ] as unknown as ActionConnector[],
+      defaultEmail: {
+        to: ['[email protected]'],
+      },
+      translations: {
+        defaultActionMessage: SyntheticsMonitorStatusTranslations.defaultActionMessage,
+        defaultRecoveryMessage: SyntheticsMonitorStatusTranslations.defaultRecoveryMessage,
+        defaultSubjectMessage: SyntheticsMonitorStatusTranslations.defaultSubjectMessage,
+        defaultRecoverySubjectMessage:
+          SyntheticsMonitorStatusTranslations.defaultRecoverySubjectMessage,
+      },
+    });
+    expect(resp).toEqual([
+      {
+        frequency: {
+          notifyWhen: 'onActionGroupChange',
+          summary: false,
+          throttle: null,
+        },
+        group: 'recovered',
+        id: 'f2a3b195-ed76-499a-805d-82d24d4eeba9',
+        params: {
+          subAction: 'closeAlert',
+          subActionParams: {
+            alias: '{{rule.id}}:{{alert.id}}',
+            description:
+              'The alert for monitor "{{context.monitorName}}" from {{context.locationNames}} is no longer active: {{context.recoveryReason}}. - Elastic Synthetics\n\nDetails:\n\n- Monitor name: {{context.monitorName}}  \n- {{context.monitorUrlLabel}}: {{{context.monitorUrl}}}  \n- Monitor type: {{context.monitorType}}  \n- From: {{context.locationNames}}  \n- Last error received: {{{context.lastErrorMessage}}}  \n{{{context.linkMessage}}}',
+            message:
+              'Monitor "{{context.monitorName}}" ({{context.locationNames}}) {{context.recoveryStatus}} - Elastic Synthetics',
+            priority: 'P2',
+            tags: ['{{rule.tags}}'],
+          },
+        },
+      },
+      {
+        frequency: {
+          notifyWhen: 'onActionGroupChange',
+          summary: false,
+          throttle: null,
+        },
+        group: 'xpack.synthetics.alerts.actionGroups.monitorStatus',
+        id: 'f2a3b195-ed76-499a-805d-82d24d4eeba9',
+        params: {
+          subAction: 'createAlert',
+          subActionParams: {
+            alias: '{{rule.id}}:{{alert.id}}',
+            description:
+              'Monitor "{{context.monitorName}}" is {{{context.status}}} from {{context.locationNames}}.{{{context.pendingLastRunAt}}} - Elastic Synthetics\n\nDetails:\n\n- Monitor name: {{context.monitorName}}  \n- {{context.monitorUrlLabel}}: {{{context.monitorUrl}}}  \n- Monitor type: {{context.monitorType}}  \n- Checked at: {{context.checkedAt}}  \n- From: {{context.locationNames}}  \n- Reason: {{{context.reason}}} \n- Error received: {{{context.lastErrorMessage}}}  \n{{{context.linkMessage}}}',
+            message:
+              'Monitor "{{context.monitorName}}" ({{context.locationNames}}) is down - Elastic Synthetics',
+            priority: 'P2',
+            tags: ['{{rule.tags}}'],
+          },
+        },
+      },
+    ]);
+  });
 });
diff --git a/x-pack/plugins/observability_solution/synthetics/common/rules/alert_actions.ts b/x-pack/plugins/observability_solution/synthetics/common/rules/alert_actions.ts
@@ -14,10 +14,12 @@ import type {
   WebhookActionParams,
   EmailActionParams,
   SlackApiActionParams,
+  OpsgenieActionParams,
 } from '@kbn/stack-connectors-plugin/server/connector_types';
 import { RuleAction as RuleActionOrig } from '@kbn/alerting-plugin/common';
 import { v4 as uuidv4 } from 'uuid';
 
+import { OpsgenieSubActions } from '@kbn/stack-connectors-plugin/common';
 import { ActionConnector, ActionTypeId } from './types';
 import { DefaultEmail } from '../runtime_types';
 
@@ -31,6 +33,7 @@ export const SERVICE_NOW_ACTION_ID: ActionTypeId = '.servicenow';
 export const JIRA_ACTION_ID: ActionTypeId = '.jira';
 export const WEBHOOK_ACTION_ID: ActionTypeId = '.webhook';
 export const EMAIL_ACTION_ID: ActionTypeId = '.email';
+export const OPSGENIE_ACTION_ID: ActionTypeId = '.opsgenie';
 
 export type RuleAction = Omit<RuleActionOrig, 'actionTypeId'>;
 
@@ -128,6 +131,14 @@ export function populateAlertActions({
           actions.push(recoveredAction);
         }
         break;
+      case OPSGENIE_ACTION_ID:
+        // @ts-expect-error
+        action.params = getOpsgenieActionParams(translations);
+        // @ts-expect-error
+        recoveredAction.params = getOpsgenieActionParams(translations, true);
+        actions.push(recoveredAction);
+        break;
+
       default:
         action.params = {
           message: translations.defaultActionMessage,
@@ -293,3 +304,24 @@ function getEmailActionParams(
     },
   };
 }
+
+function getOpsgenieActionParams(
+  {
+    defaultActionMessage,
+    defaultSubjectMessage,
+    defaultRecoverySubjectMessage,
+    defaultRecoveryMessage,
+  }: Translations,
+  isRecovery?: boolean
+): OpsgenieActionParams {
+  return {
+    subAction: isRecovery ? OpsgenieSubActions.CloseAlert : OpsgenieSubActions.CreateAlert,
+    subActionParams: {
+      alias: '{{rule.id}}:{{alert.id}}',
+      tags: ['{{rule.tags}}'],
+      message: isRecovery ? defaultRecoverySubjectMessage : defaultSubjectMessage,
+      description: isRecovery ? defaultRecoveryMessage : defaultActionMessage,
+      priority: 'P2',
+    },
+  } as OpsgenieActionParams;
+}
diff --git a/x-pack/plugins/observability_solution/synthetics/common/rules/types.ts b/x-pack/plugins/observability_solution/synthetics/common/rules/types.ts
@@ -16,6 +16,7 @@ import type {
   TeamsConnectorTypeId,
   WebhookConnectorTypeId,
   EmailConnectorTypeId,
+  OpsgenieConnectorTypeId,
 } from '@kbn/stack-connectors-plugin/server/connector_types';
 
 import type { ActionConnector as RawActionConnector } from '@kbn/triggers-actions-ui-plugin/public';
@@ -31,6 +32,7 @@ export type ActionTypeId =
   | typeof ServiceNowConnectorTypeId
   | typeof JiraConnectorTypeId
   | typeof WebhookConnectorTypeId
-  | typeof EmailConnectorTypeId;
+  | typeof EmailConnectorTypeId
+  | typeof OpsgenieConnectorTypeId;
 
 export type ActionConnector = Omit<RawActionConnector, 'secrets'> & { config?: SlackApiConfig };
diff --git a/x-pack/plugins/stack_connectors/server/connector_types/index.ts b/x-pack/plugins/stack_connectors/server/connector_types/index.ts
@@ -63,6 +63,7 @@ export { ConnectorTypeId as WebhookConnectorTypeId } from './webhook';
 export type { ActionParamsType as WebhookActionParams } from './webhook/types';
 export { ConnectorTypeId as XmattersConnectorTypeId } from './xmatters';
 export type { ActionParamsType as XmattersActionParams } from './xmatters';
+export { OpsgenieConnectorTypeId } from './opsgenie';
 
 export type {
   OpsgenieActionConfig,

diff --git a/x-pack/plugins/stack_connectors/server/connector_types/opsgenie/index.ts b/x-pack/plugins/stack_connectors/server/connector_types/opsgenie/index.ts
@@ -39,6 +39,8 @@ export const getOpsgenieConnectorType = (): SubActionConnectorType<Config, Secre
   };
 };
 
+export { OpsgenieConnectorTypeId };
+
 export type {
   Config as OpsgenieActionConfig,
   Secrets as OpsgenieActionSecrets,