OpsGenie v1 事件处理器
OpsGenie 是一个面向 DevOps 和 ITOps 团队的事件响应编排平台。Kapacitor 可以配置为向 OpsGenie 发送警报消息。
此页面特定于 OpsGenie 的 v1 API,该 API 已被弃用。OpsGenie 建议迁移到其 v2 API。查看 OpsGenie API 迁移指南,了解有关升级的更多信息。如果使用 v2 API,请查看 OpsGenie v2 事件处理器 文档。
配置
OpsGenie v1 事件处理器的配置以及默认 选项 值在您的 kapacitor.conf
中设置。以下是一个配置示例
[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
设置为 true
以启用 OpsGenie v1 事件处理器。
api-key
您的 OpsGenie API 密钥。
teams
默认 OpsGenie 团队。可以为每个警报覆盖。
recipients
默认 OpsGenie 收件人。可以为每个警报覆盖。
url
OpsGenie API URL。这应该不需要更改。
recovery_url
OpsGenie 恢复 URL。根据您希望恢复触发的行为(添加注释、关闭警报等)更改此项。
global
如果为 true
,则所有警报都将发送到 OpsGenie,而无需在 TICKscript 中指定 opsgenie
。团队和收件人仍然可以被覆盖。
选项
以下 OpsGenie v1 事件处理器选项可以在 处理程序文件 中设置,或者在使用 TICKscript 中的 .opsGenie()
时设置。
名称 | 类型 | 描述 |
---|---|---|
teams-list | 字符串列表 | 团队列表。 |
recipients-list | 字符串列表 | 收件人列表。 |
示例:处理程序文件
id: handler-id
topic: topic-name
kind: opsgenie
options:
teams-list:
- 'team1'
- 'team2'
recipients-list:
- 'recipient1'
- 'recipient2'
示例:TICKscript
|alert()
// ...
.opsGenie()
.teams('team1', 'team2')
.recipients('recipient1', 'recipient2')
OpsGenie 设置
要允许 Kapacitor 向 OpsGenie 发送警报,创建一个 OpsGenie API 集成。在您的 kapacitor.conf
的 [opsgenie]
部分中使用生成的 API 密钥作为 api-key
使用 OpsGenie 事件处理器
在您的 kapacitor.conf
中启用和配置 OpsGenie v1 事件处理器后,在您的 TICKscript 中使用 .opsGenie()
属性向 OpsGenie 发送警报,或定义一个 OpsGenie v1 处理程序,该处理程序订阅一个主题并将发布的警报发送到 OpsGenie。
以下示例使用在 kapacitor.conf
中定义的以下 OpsGenie 配置
kapacitor.conf 中的 OpsGenie v1 设置
[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
从 TICKscript 向 OpsGenie 发送警报
以下 TICKscript 使用 .opsGenie()
事件处理器将消息 “Hey, check your CPU” 发送到 OpsGenie,每当空闲 CPU 使用率降至 10% 以下时。
opsgenie-cpu-alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: 'usage_idle' < 10)
.message('Hey, check your CPU')
.opsGenie()
.teams('engineering', 'support')
从定义的处理程序向 OpsGenie 发送警报
以下设置向 cpu
主题发送警报,消息为 “Hey, check your CPU”。添加了一个 OpsGenie v1 处理程序,该处理程序订阅 cpu
主题并将所有警报消息发布到 OpsGenie。
创建一个 TICKscript,将警报消息发布到主题。以下 TICKscript 在任何时候空闲 CPU 使用率降至 10% 以下时,向 cpu
主题发送警报消息。
cpu_alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: 'usage_idle' < 10)
.message('Hey, check your CPU')
.topic('cpu')
添加并启用 TICKscript
kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert
创建一个处理程序文件,该文件订阅 cpu
主题并使用 OpsGenie v1 事件处理器向 OpsGenie 发送警报。
opsgenie_cpu_handler.yaml
id: opsgenie-cpu-alert
topic: cpu
kind: opsgenie
options:
teams-list:
- 'engineering'
- 'support'
添加处理程序
kapacitor define-topic-handler opsgenie_cpu_handler.yaml
此页面是否对您有帮助?
感谢您的反馈!
支持和反馈
感谢您成为我们社区的一份子!我们欢迎并鼓励您提供关于 Kapacitor 和本文档的反馈和错误报告。要获得支持,请使用以下资源