Opsgenie connector and action | Kibana Guide

› › ›

« Microsoft Teams connector and action PagerDuty connector and action »

Opsgenie connector and actionedit

The Opsgenie connector uses the Opsgenie alert API.

Create connectors in Kibanaedit

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

Connector configurationedit

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 connectorsedit

You can test connectors with the run connector API or as you’re creating or editing the connector in Kibana. For example:

The Opsgenie connector supports two types of actions: Create alert and Close alert. The properties supported for each action are different because Opsgenie defines different properties for each operation.

When testing the Opsgenie connector, choose the appropriate action from the selector. Each action has different properties that can be configured.

Action: Select Create alert to configure the actions that occur when a rule’s conditions are met. Select Close alert to define the recovery actions that occur when a rule’s conditions are no longer met.

Configure the create alert actionedit

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

Form viewedit

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 editoredit

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":"trinity@opsgenie.com", "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":"trinity@opsgenie.com","type":"user"}
  ],
  "actions": ["Restart", "AnExampleAction"],
  "tags": ["OverwriteQuietHours","Critical"],
  "details":{"key1":"value1","key2":"value2"},
  "entity":"An example entity",
  "priority":"P1"
}

Close alert configurationedit

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 configurationedit

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 accountedit

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.

« Microsoft Teams connector and action PagerDuty connector and action »