OpsGenie v1 event handler
OpsGenie is an incident response orchestration platform for DevOps & ITOps teams. Kapacitor can be configured to send alert messages to OpsGenie.
This page is specific to OpsGenie’s v1 API which has been deprecated. OpsGenie recommends migrating to their v2 API. View the OpsGenie API migration guide for more information about upgrading. If using the v2 API, view the OpsGenie v2 event handler documentation.
Configuration
Configuration as well as default option values for the OpsGenie v1
event handler are set in your kapacitor.conf
.
Below is an example configuration:
[opsgenie]
enabled = true
api-key = "mysupersecretapikey"
teams = ["team1", "team2"]
recipients = ["recipient1", "recipient2"]
url = "https://api.opsgenie.com/v1/json/alert"
recovery_url = "https://api.opsgenie.com/v1/json/alert/note"
global = false
enabled
Set to true
to enable the OpsGenie v1 event handler.
api-key
Your OpsGenie API Key.
teams
Default OpsGenie teams. Can be overridden per alert.
recipients
Default OpsGenie recipients. Can be overridden per alert.
url
The OpsGenie API URL. This should not need to be changed.
recovery_url
The OpsGenie Recovery URL. Change this based on which behavior you want a recovery to trigger (add notes, close alert, etc.)
global
If true
, all alerts are sent to OpsGenie without specifying opsgenie
in the
TICKscript.
The team and recipients can still be overridden.
Options
The following OpsGenie v1 event handler options can be set in a
handler file or when using
.opsGenie()
in a TICKscript.
Name | Type | Description |
---|---|---|
teams-list | list of strings | List of teams. |
recipients-list | list of strings | List of recipients. |
Example: handler file
id: handler-id
topic: topic-name
kind: opsgenie
options:
teams-list:
- 'team1'
- 'team2'
recipients-list:
- 'recipient1'
- 'recipient2'
Example: TICKscript
|alert()
// ...
.opsGenie()
.teams('team1', 'team2')
.recipients('recipient1', 'recipient2')
OpsGenie Setup
To allow Kapacitor to send alerts to OpsGenie,
create an OpsGeneie API Integration.
Use the generated API key as the api-key
in the [opsgenie]
section of your
kapacitor.conf
Using the OpsGenie event handler
With the OpsGenie v1 event handler enabled and configured in your
kapacitor.conf
, use the .opsGenie()
attribute in your TICKscripts to send
alerts to OpsGenie or define a OpsGenie v1 handler that subscribes to a topic
and sends published alerts to OpsGenie.
The examples below use the following OpsGenie configuration defined in the kapacitor.conf
:
OpsGenie v1 settings in kapacitor.conf
[opsgenie]
enabled = true
api-key = "mysupersecretapikey"
teams = ["engineering"]
recipients = ["supervisor1", "supervisor2"]
url = "https://api.opsgenie.com/v1/json/alert"
recovery_url = "https://api.opsgenie.com/v1/json/alert/note"
global = false
Send alerts to OpsGenie from a TICKscript
The following TICKscript uses the .opsGenie()
event handler to send the message,
“Hey, check your CPU”, to OpsGenie whenever idle CPU usage drops below 10%.
opsgenie-cpu-alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: 'usage_idle' < 10)
.message('Hey, check your CPU')
.opsGenie()
.teams('engineering', 'support')
Send alerts to OpsGenie from a defined handler
The following setup sends an alert to the cpu
topic with the message, “Hey,
check your CPU”. An OpsGenie v1 handler is added that subscribes to the cpu
topic and publishes all alert messages to OpsGenie.
Create a TICKscript that publishes alert messages to a topic.
The TICKscript below sends an alert message to the cpu
topic any time idle CPU
usage drops below 10%.
cpu_alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: 'usage_idle' < 10)
.message('Hey, check your CPU')
.topic('cpu')
Add and enable the TICKscript:
kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert
Create a handler file that subscribes to the cpu
topic and uses the OpsGenie v1
event handler to send alerts to OpsGenie.
opsgenie_cpu_handler.yaml
id: opsgenie-cpu-alert
topic: cpu
kind: opsgenie
options:
teams-list:
- 'engineering'
- 'support'
Add the handler:
kapacitor define-topic-handler opsgenie_cpu_handler.yaml
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Kapacitor and this documentation. To find support, use the following resources: