Opsgenie connector and action

An Opsgenie connector enables you to create and close alerts in Opsgenie. In particular, it uses the Opsgenie alert API.

To create this connector, you must have a valid Opsgenie URL and API key. For configuration tips, refer to Configure an Opsgenie account.

Create connectors in Kibana

edit

You can create connectors in Stack Management > Connectors or as needed when you’re creating a rule. For example:

Connector configuration

edit

Opsgenie connectors have the following configuration properties:

Name: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
URL: The Opsgenie URL. For example, https://api.opsgenie.com or https://api.eu.opsgenie.com.

If you are using the xpack.actions.allowedHosts setting, make sure the hostname is added to the allowed hosts.
API Key: The Opsgenie API authentication key for HTTP basic authentication. For more details about generating Opsgenie API keys, refer to Opsgenie documentation.

Test connectors

edit

After you create a connector, use the Test tab to test its actions:

Create alert action

edit

When you create a rule that uses an Opsgenie connector, its actions (with the exception of recovery actions) create Opsgenie alerts. You can test this type of action when you create or edit your connector:

You can configure the create alert action through the form view or using a JSON editor.

Form view

edit

The create alert action form has the following configuration properties.

Message: The message for the alert (required).
Opsgenie tags: The tags for the alert (optional).
Priority: The priority level for the alert.
Description: A description that provides detailed information about the alert (optional).
Alias: The alert identifier, which is used for alert deduplication in Opsgenie. For more information, refer to the Opsgenie documentation (optional).
Entity: The domain of the alert (optional).
Source: The source of the alert (optional).
User: The display name of the owner (optional).
Note: Additional information for the alert (optional).

JSON editor

edit

A JSON editor is provided as an alternative to the form view and supports additional fields not shown in the form view. The JSON editor supports all of the forms configuration properties but as lowercase keys as described in the Opsgenie API documentation. The JSON editor supports the following additional properties:

responders: The entities to receive notifications about the alert (optional).
visibleTo: The teams and users that the alert will be visible to without sending a notification to them (optional).
actions: The custom actions available to the alert (optional).
details: The custom properties of the alert (optional).

Example JSON editor contents

{
  "message": "An example alert message",
  "alias": "Life is too short for no alias",
  "description":"Every alert needs a description",
  "responders":[
      {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type":"team"},
      {"name":"NOC", "type":"team"},
      {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type":"user"},
      {"username":"[email protected]", "type":"user"},
      {"id":"aee8a0de-c80f-4515-a232-501c0bc9d715", "type":"escalation"},
      {"name":"Nightwatch Escalation", "type":"escalation"},
      {"id":"80564037-1984-4f38-b98e-8a1f662df552", "type":"schedule"},
      {"name":"First Responders Schedule", "type":"schedule"}
  ],
  "visibleTo":[
      {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},
      {"name":"rocket_team","type":"team"},
      {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"},
      {"username":"[email protected]","type":"user"}
  ],
  "actions": ["Restart", "AnExampleAction"],
  "tags": ["OverwriteQuietHours","Critical"],
  "details":{"key1":"value1","key2":"value2"},
  "entity":"An example entity",
  "priority":"P1"
}

Close alert action

edit

When you create a rule that uses an Opsgenie connector, its recovery actions close Opsgenie alerts. You can test this type of action when you create or edit your connector:

The close alert action has the following configuration properties.

Alias: The alert identifier, which is used for alert deduplication in Opsgenie (required). The alias must match the value used when creating the alert. For more information, refer to the Opsgenie documentation.
Note: Additional information for the alert (optional).
Source: The display name of the source (optional).
User: The display name of the owner (optional).

Connector networking configuration

edit

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

Configure an Opsgenie account

edit

After obtaining an Opsgenie instance, configure the API integration. For details, refer to the Opsgenie documentation.

If you’re using a free trial, go to the Teams dashboard and select the appropriate team.

Select the Integrations menu item, then select Add integration.

Search for API and select the API integration.

Configure the integration and ensure you record the API Key. This key will be used to populate the API Key field when creating the Kibana Opsgenie connector. Click Save Integration after you finish configuring the integration.

« OpenAI connector and action PagerDuty connector and action »