[ResponseOps][Stack Connectors] Opsgenie backend by jonathan-buttner · Pull Request #142164 · elastic/kibana

jonathan-buttner · 2022-09-28T21:39:39Z

This PR implements the backend of the opsgenie connector.

Issue: #142776

Opsgenie API Docs: https://docs.opsgenie.com/docs/alert-api#create-alert

Examples

Creating alerts

Postman creating connector

Postman creating an alert

Created Alerts within Opsgenie

Closing alerts

Postman closing an alert

Closed alert within Opsgenie

Testing

Create an Opsgenie account here: https://www.atlassian.com/software/opsgenie
Create a team
On the team page there should be Integrations on the left, click that, then click Add Integration
Search for and add API Integration
After the integration is added, it will create an API key for use in the following APIs, save this key for later
Click Save Integration

Creating a connector

curl

curl --location --request POST 'http://elastic:changeme@localhost:5601/api/actions/connector' \
--header 'kbn-xsrf: foo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Opsgenie",
    "connector_type_id": ".opsgenie",
    "config": {
        "apiUrl": "https://api.opsgenie.com"
    },
    "secrets": {
        "apiKey": "<apiKey>"
    }
}'

Raw

POST http://elastic:changeme@localhost:5601/api/actions/connector

{
    "name": "Opsgenie",
    "connector_type_id": ".opsgenie",
    "config": {
        "apiUrl": "https://api.opsgenie.com"
    },
    "secrets": {
        "apiKey": "<apiKey>"
    }
}

Closing an alert

curl

curl --location --request POST 'http://elastic:changeme@localhost:5601/api/actions/connector/<connector_id>/_execute' \
--header 'kbn-xsrf: foo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "params": {
        "subAction": "createAlert",
        "subActionParams": {
            "message": "It worked"
        }
    }
}'

Raw

POST http://elastic:changeme@localhost:5601/api/actions/connector/<connector_id>/_execute

{
    "params": {
        "subAction": "closeAlert",
        "subActionParams": {
            "alias": "123"
        }
    }
}

jonathan-buttner · 2022-10-05T19:05:13Z

x-pack/plugins/stack_connectors/README.md

 ## User interface

-To make this connector usable in the Kibana UI, you will need to provide all the UI editing aspects of the connector. The existing connector type user interfaces are defined in [`x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types`](../triggers_actions_ui/public/application/components/builtin_action_types). For more information, see the [UI documentation](../triggers_actions_ui/README.md#create-and-register-new-action-type-ui).
+To make this connector usable in the Kibana UI, you will need to provide all the UI editing aspects of the connector. The existing connector type user interfaces are defined in [`x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types`](../triggers_actions_ui/public/application/components/builtin_action_types). For more information, see the [UI documentation](../triggers_actions_ui/README.md#create-and-register-new-action-type-ui).


I think this was a whitespace change 🤔

elasticmachine · 2022-10-06T14:49:28Z

Pinging @elastic/response-ops (Team:ResponseOps)

jonathan-buttner · 2022-10-06T14:50:43Z

x-pack/plugins/stack_connectors/server/connector_types/stack/index.ts

 } from './webhook';
 export type { ActionParamsType as WebhookActionParams } from './webhook';

+export { getOpsgenieConnectorType, OpsgenieConnectorTypeId } from './opsgenie';


I'll add the OpsgenieActionParams in the next UI PR when it's actually needed externally

cnasikas · 2022-10-10T10:32:29Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/connector.ts

+
+  public getResponseErrorMessage(error: AxiosError<ErrorSchema>) {
+    return `Message: ${
+      error.response?.data.errors?.message ?? error.response?.data.message ?? i18n.UNKNOWN_ERROR


Can we add another fallback to include the error message? For example, error.response?.data.errors?.message ?? error.response?.data.message ?? error.message ?? i18n.UNKNOWN_ERROR. I am also thinking if we should improve the message thrown by the SubActionConnector class in the request method. At the moment we do

const errorMessage = this.getResponseErrorMessage(error); throw new Error(errorMessage);

Maybe we can include more details like the status code. For example,

const errorMessage = `Status code: ${error.status}. Message: ${this.getResponseErrorMessage(error)}`; throw new Error(errorMessage);

What do you think? @pmuellr Any information you think we should include in the error message to help us with SDHs?

cnasikas · 2022-10-10T10:35:00Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/connector.ts

+  }
+
+  private createHeaders() {
+    return { Authorization: `GenieKey ${this.secrets.apiKey}`, 'Content-Type': 'application/json' };


The content type header is added automatically by the framework here https://github.com/cnasikas/kibana/blob/cf689fad73f108d47a8e29a0d5afd1baab6f46b6/x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts#L83

cnasikas · 2022-10-10T10:41:29Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/connector.ts

+  }
+
+  public async closeAlert(params: CloseAlertParams) {
+    const fullURL = new URL(`v2/alerts/${params.alias}/close`, this.config.apiUrl);


Shouldn't we use the concatPathToURL helper function? The concatPathToURL can return the URL object so we can set the searchParams.

Yeah good idea.

cnasikas · 2022-10-10T10:52:18Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/schema.ts

+const validateDetails = (details: Record<string, string>): string | void => {
+  let totalChars = 0;
+
+  for (const [key, value] of Object.entries(details)) {
+    totalChars += key.length + value.length;
+
+    if (totalChars > 8000) {
+      return i18n.translate('xpack.stackConnectors.opsgenie.invalidDetails', {
+        defaultMessage: 'details field character count exceeds the 8000 limit',
+      });
+    }
+  }
+};


According to the docs here we should only validate the values and not the whole JSON string (keys included). The Extra Properties is the details. You can test it if you open the Network Tab in your dev tools. The API docs are misleading. I thought the same as you at first 🙂 .

Also, if we had to validate the whole JSON string I think it is better to do

const validateDetails = (details: Record<string, string>): string | void => { let totalChars = 0; try { JSON.stringify(details).length } catch (e) { // throw error about JSON stringify } if (totalChars > 8000) { return i18n.translate('xpack.stackConnectors.opsgenie.invalidDetails', { defaultMessage: 'details field character count exceeds the 8000 limit', }); } };

because we need to validate {, ,, and }

Great catch!

cnasikas · 2022-10-10T11:14:42Z

...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/stack/opsgenie.ts

+              .send({
+                params: {},
+              })
+              .then((resp: any) => {


nit: For readability maybe is better to do:

const res = await supertest.post(...).set(...).send(...).expect(200) // the expects expect(resp.body.connector_id).to.eql(opsgenieActionId); ....

cnasikas · 2022-10-10T11:20:11Z

...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/stack/opsgenie.ts

+              });
+          });
+        });
+      });


I think we should add more tests to validate some of the optional fields.

cnasikas · 2022-10-10T11:31:56Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/connector.test.ts

+  });
+
+  it('calls request with the correct arguments for creating an alert', async () => {
+    const connectorSpy = jest


I think is better to mock axios instead of the method of the class. This way if the sub-action framework introduces an unintended breaking change or a feature change your tests can catch it. You can follow the examples here x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.test.ts

cnasikas · 2022-10-10T11:34:20Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/connector.ts

+  public getResponseErrorMessage(error: AxiosError<ErrorSchema>) {
+    return `Message: ${
+      error.response?.data.errors?.message ?? error.response?.data.message ?? i18n.UNKNOWN_ERROR
+    }.`;


I think we should omit the dot. I got an error while testing and I noticed that there are two dots in the message. For example: "Message: To perform this action, use an API key from an API integration.."

ymao1 · 2022-10-10T18:24:53Z

If I am reading "Connector collaboration" doc correctly, Opsgenie should go under the cases subfolder, not the stack subfolder. Is that not the case? Happy to update the doc if so!

jonathan-buttner · 2022-10-10T19:24:12Z

If I am reading "Connector collaboration" doc correctly, Opsgenie should go under the cases subfolder, not the stack subfolder. Is that not the case? Happy to update the doc if so!

@cnasikas what do you think? We might not support cases initially. From that doc it seems like any connector that has support for cases should be moved to the cases directory.

cnasikas · 2022-10-11T12:44:40Z

x-pack/plugins/stack_connectors/server/connector_types/stack/opsgenie/schema.ts

+  schema.literal('schedule'),
+]);
+
+const validateDetails = (details: Record<string, string>): string | void => {


Sorry if I confused you before, but I meant that each value has to be less than 8K characters. Not collectively. You can have two values with 8K characters for each.

Ooooooh got it.

We decided to remove the validation offline because opsgenie will just truncate the strings and not throw an error.

jonathan-buttner · 2022-10-11T14:30:12Z

@elasticmachine merge upstream

cnasikas

Code LTGM! Tested without any issues. I could create and close an alert in OpsGenie. 🚀

jonathan-buttner · 2022-10-11T17:29:54Z

@elasticmachine merge upstream

…na into opsgenie-connector

kibana-ci · 2022-10-11T19:28:38Z

💚 Build Succeeded

Buildkite Build
Commit: 5483dbb

Metrics [docs]

✅ unchanged

History

💔 Build #79414 failed 13431f0
💚 Build #79201 succeeded cf442ad
💚 Build #78820 succeeded b2b7e53
💔 Build #78755 failed c79afdc
💔 Build #78534 failed 9892a2d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Starting opsgenie backend

33bcdcc

jonathan-buttner added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v8.6.0 labels Sep 28, 2022

jonathan-buttner added 3 commits September 29, 2022 09:24

Merge branch 'main' of github.com:elastic/kibana into opsgenie-connector

7413f2c

Adding more integration tests

dcb1fd9

Updating readme

b6950fc

jonathan-buttner changed the title ~~[ResponseOps][Cases] Opsgenie backend~~ [ResponseOps][Stack Connectors] Opsgenie backend Sep 30, 2022

jonathan-buttner mentioned this pull request Sep 30, 2022

[ResponseOps][Stack Connectors] Opsgenie connector UI #142411

Merged

jonathan-buttner added 3 commits October 4, 2022 13:50

Merge branch 'main' of github.com:elastic/kibana into opsgenie-connector

0ba5a6c

Adding hash and alias

0111502

Fixing tests

af4a94a

jonathan-buttner mentioned this pull request Oct 5, 2022

[ResponseOps][Connectors] Opsgenie Connector #142776

Closed

10 tasks

jonathan-buttner added 2 commits October 5, 2022 15:00

Switch to platinum for now

3eb263a

Adding server side translations

854492b

jonathan-buttner commented Oct 5, 2022

View reviewed changes

jonathan-buttner added 4 commits October 5, 2022 15:29

Merge branch 'main' of github.com:elastic/kibana into opsgenie-connector

a08975b

Fixing merge issues

9892a2d

Merge branch 'main' of github.com:elastic/kibana into opsgenie-connector

40bbcc4

Fixing file location error

c79afdc

jonathan-buttner marked this pull request as ready for review October 6, 2022 14:49

jonathan-buttner requested review from a team as code owners October 6, 2022 14:49

jonathan-buttner requested review from cnasikas and peteharverson October 6, 2022 14:49

jonathan-buttner commented Oct 6, 2022

View reviewed changes

Fixing test

b2b7e53

cnasikas reviewed Oct 10, 2022

View reviewed changes

jonathan-buttner added 2 commits October 10, 2022 13:38

Addressing feedback

d3012f9

Merge branch 'main' of github.com:elastic/kibana into opsgenie-connector

cf442ad

cnasikas reviewed Oct 11, 2022

View reviewed changes

Removing details validation

22d32ad

Merge branch 'main' into opsgenie-connector

13431f0

cnasikas approved these changes Oct 11, 2022

View reviewed changes

kibanamachine and others added 3 commits October 11, 2022 11:29

Merge branch 'main' into opsgenie-connector

b233bbb

Fixing close alert alias bug

fef41ba

Merge branch 'opsgenie-connector' of github.com:jonathan-buttner/kiba…

5483dbb

…na into opsgenie-connector

jonathan-buttner merged commit b86bb63 into elastic:main Oct 11, 2022

jonathan-buttner deleted the opsgenie-connector branch October 11, 2022 19:43

jonathan-buttner mentioned this pull request Oct 25, 2022

[ResponseOps][Stack Connectors] Opsgenie UI phase 2 #143480

Merged

Conversation

jonathan-buttner commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples

Creating alerts

Closing alerts

Testing

Creating a connector

Closing an alert

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Oct 6, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cnasikas Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cnasikas Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ymao1 commented Oct 10, 2022

Uh oh!

jonathan-buttner commented Oct 10, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner commented Oct 11, 2022

Uh oh!

cnasikas left a comment

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner commented Oct 11, 2022

Uh oh!

kibana-ci commented Oct 11, 2022

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jonathan-buttner commented Sep 28, 2022 •

edited

Loading

cnasikas Oct 10, 2022 •

edited

Loading

cnasikas Oct 10, 2022 •

edited

Loading