Opsgenie 连接器和操作

编辑

Opsgenie 连接器和操作编辑

Opsgenie 连接器使您能够在 Opsgenie 中创建和关闭警报。具体来说,它使用 Opsgenie 警报 API

要创建此连接器,您必须拥有有效的 Opsgenie URL 和 API 密钥。有关配置提示,请参阅 配置 Opsgenie 帐户

在 Kibana 中创建连接器编辑

您可以在 堆栈管理 > 连接器 中创建连接器,也可以在创建规则时根据需要创建连接器。例如

Opsgenie connector
连接器配置编辑

Opsgenie 连接器具有以下配置属性

名称
连接器的名称。该名称用于在管理 UI 连接器列表中或在配置操作时的连接器列表中标识连接器。
URL

Opsgenie URL。例如,https://api.opsgenie.comhttps://api.eu.opsgenie.com

如果您正在使用 xpack.actions.allowedHosts 设置,请确保将主机名添加到允许的主机中。

API 密钥
用于 HTTP 基本身份验证的 Opsgenie API 身份验证密钥。有关生成 Opsgenie API 密钥的更多详细信息,请参阅 Opsgenie 文档

测试连接器编辑

创建连接器后,使用 测试 选项卡测试其操作

创建警报操作编辑

当您创建使用 Opsgenie 连接器的规则时,其操作(恢复操作除外)会创建 Opsgenie 警报。您可以在创建或编辑连接器时测试此类操作

Opsgenie create alert action test

您可以通过表单视图或使用 JSON 编辑器配置创建警报操作。

表单视图编辑

创建警报操作表单具有以下配置属性。

消息
警报消息(必填)。
Opsgenie 标签
警报标签(可选)。
优先级
警报的优先级。
描述
提供有关警报的详细信息的描述(可选)。
别名
警报标识符,用于在 Opsgenie 中进行警报重复数据删除。有关更多信息,请参阅 Opsgenie 文档(可选)。
实体
警报的域(可选)。
来源
警报的来源(可选)。
用户
所有者的显示名称(可选)。
备注
警报的附加信息(可选)。
JSON 编辑器编辑

提供了一个 JSON 编辑器作为表单视图的替代方案,并支持表单视图中未显示的其他字段。JSON 编辑器支持所有表单配置属性,但使用小写键,如 Opsgenie API 文档中所述。JSON 编辑器支持以下附加属性

响应者
接收有关警报的通知的实体(可选)。
可见范围
警报对哪些团队和用户可见,但不会向其发送通知(可选)。
操作
警报可用的自定义操作(可选)。
详细信息
警报的自定义属性(可选)。

JSON 编辑器内容示例

{
  "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"
}
关闭警报操作编辑

当您创建使用 Opsgenie 连接器的规则时,其恢复操作会关闭 Opsgenie 警报。您可以在创建或编辑连接器时测试此类操作

Opsgenie close alert action test

关闭警报操作具有以下配置属性。

别名
警报标识符,用于在 Opsgenie 中进行警报重复数据删除(必填)。别名必须与创建警报时使用的值匹配。有关更多信息,请参阅 Opsgenie 文档
备注
警报的附加信息(可选)。
来源
来源的显示名称(可选)。
用户
所有者的显示名称(可选)。

连接器网络配置编辑

使用 操作配置设置来自定义连接器网络配置,例如代理、证书或 TLS 设置。您可以设置适用于所有连接器的配置,也可以使用 xpack.actions.customHostSettings 设置每个主机的配置。

配置 Opsgenie 帐户编辑

获取 Opsgenie 实例后,配置 API 集成。有关详细信息,请参阅 Opsgenie 文档

如果您使用的是免费试用版,请转到 团队 仪表板并选择相应的团队。

Opsgenie teams dashboard

选择 集成 菜单项,然后选择 添加集成

Opsgenie teams integrations

搜索 API 并选择 API 集成。

Opsgenie API integration

配置集成并确保记录 API 密钥。此密钥将用于在创建 Kibana Opsgenie 连接器时填充 API 密钥 字段。配置完集成后,单击 保存集成

Opsgenie save integration