告警机器人配置

DataLeap 在任务运维和数据质量监控模块中，支持通过飞书、飞书群消息的方式来发送告警。您可以在使用飞书相关告警之前，进行机器人的创建，并在火山引擎的用户详情中绑定相应的飞书账号。
本文将为您介绍在使用飞书告警前需要进行的一些前置操作，以确保告警能顺利通过飞书消息发送。这些操作包括机器人创建、飞书账号的绑定以及飞书群ID等信息获取。在完成这些步骤后，您便可及时地将任务告警和数据质量告警发送到相应的飞书账号中。

1 机器人创建

飞书机器人目前支持两类，分别是飞书应用机器人和自定义机器人：

• 飞书应用机器人：
  飞书自建的应用开启机器人能力，并经过相关的配置和授权后，您可将应用机器人添加到群组中使用，并支持调用飞书丰富的开放接口，完成与应用机器人更多的互动场景。在 DataLeap 监控告警场景中，应用机器人便可通过飞书或飞书加急的方式，将监控告警信息推送至飞书或飞书群中。
• 自定义机器人：
  自定义机器人是一类特殊的群机器人，它只能在当前群聊中使用，使用场景比较受限。DataLeap 支持配置飞书自定义机器人和钉钉自定义机器人的 Webhook 地址信息，通过 webhook 地址向飞书或钉钉群组中自动推送来自 DataLeap 监控告警系统中的消息。

两类机器人更多的介绍详见机器人概述。下面将简单为您介绍两类机器人创建的方式。

1.1 飞书应用机器人创建

在飞书开放平台中创建自建应用，并在应用中添加相应的告警机器人。

1. 登录飞书开放平台。

2. 在企业自建应用页签中，单击创建企业自建应用按钮，进行应用的创建。

3. 应用名称可以定义为在发送飞书通知时，希望显示机器人的名称。

   

4. 应用创建完成后，单击进入应用详情界面，在左侧导航栏中，单击“凭证与基础信息”按钮，在基础信息界面，获取应用的 App ID 和 App Secret。

   

5. 在左侧导航栏中，单击添加应用能力按钮，选择机器人并单击添加按钮，进行机器人添加操作。

   

6. 若应用需开启白名单限制，则您需要将服务 IP 添加到白名单列表中，仅白名单中的来源请求才可正常调用开放平台应用。

   

7. 在企业应用中，需申请以下消息发送相关的接口权限：
   在左边导航栏中，单击权限管理按钮，进入 API 权限界面，搜索或直接查询以下权限名称进行开通权限操作。

   • 发送消息：im:message
   • 通过手机号/邮箱获取用户Lark ID：contact:user.id:readonly
   • 发送应用内加急消息：im:message.urgent
   • 发送电话加急消息：im:message.urgent.phone
   • 发送短信加急：im:message.urgent:sms
   

8. 权限管理配置完成后，单击左侧导航栏中的版本管理与发布按钮，进行应用发布。

   1. 单击界面右上角创建版本按钮，填写版本号、应用说明等版本详情内容。
   2. 您也可为应用编辑可用范围成员：指收到通知成员对象的合集。
   

1.2 飞书&钉钉自定义机器人创建

DataLeap 告警消息也可通过 Webhook 形式发送，支持飞书自定义机器人和钉钉自定义机器人，配置机器人时您仅需在安全设置 > 自定义关键词中，将“DataLeap”和“dataleap”都设置为关键词即可。
下文以飞书自定义机器人配置为例为您介绍相关操作。

1. 在飞书中，创建一个目标飞书群组。

2. 在飞书群上方，单击群头像，在右侧弹出群设置窗口。

3. 单击群机器人 > 添加机器人按钮，进入添加机器人窗口。

4. 在窗口中，单击“自定义机器人”，进入机器人基本信息配置界面，完成以下配置：

   

   其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

   配置项	说明
   *机器人头像	您可按需选择机器人头像信息，可使用机器人默认头像，或单击上传头像按钮，从本地上传图片为头像信息。
   *机器人名称	输入机器人名称信息，最多输入32个字符。
   *描述	添加机器人描述信息，方便后续维护管理。

5. 基本信息填写完成后，单击添加按钮，自动生成 Webhook 地址，并在安全设置项中，勾选“自定义关键词”，并输入关键词信息：DataLeap 和 dataleap。
   

6. 自定义关键词信息配置完成后，复制 Webhook 地址，并单击完成按钮，完成自定义机器人添加。

7. 您可将该地址，复制到运维中心 > 监控规则配置界面。
   

2 应用机器人后续配置

以下机器人注册及飞书账号绑定仅针对飞书应用机器人操作，自定义机器人可跳过。

2.1 飞书应用机器人注册

参考上方操作创建飞书应用机器人完成后，记录应用机器人的 App ID 和 App Secret 信息，并将需开启飞书通知的租户 ID、产品模块名称（如数据开发、数据质量、数据安全等）信息，通过提工单的方式，提供给 DataLeap 研发支持同学，进行飞书通知的注册。

2.2 火山引擎绑定飞书账号

飞书应用机器人注册完成后，若您想通过应用机器人单独给个人飞书发送消息，则您需继续完成以下飞书账号绑定操作：

1. 主账号需要在访问控制 > 安全设置界面，开启子用户自主管理设置，子用户方能进行绑定飞书操作。

   

2. 子用户登录火山引擎控制台界面，并在右上角进入账号管理界面，单击“绑定飞书”的绑定按钮，通过验证码形式进行飞书绑定。

   

3. 飞书账号绑定成功后，您便可在运维中心 > 监控规则界面、数据质量 > 规则配置等界面，告警方式选择飞书或飞书加急的方式，便可通过应用机器人发送告警。配置详见监控规则。

2.3 飞书群绑定应用机器人

开放平台中应用机器人创建完成后，若您想通过应用机器人，将消息发送至目标飞书群中，您可前往飞书群，将创建的应用机器人添加到目标群中，添加操作如下：

1. 在目标飞书群上方，单击群头像，在右侧弹出群设置窗口。

2. 单击群机器人 > 添加机器人按钮，并在窗口中，输入搜索已发布的应用机器人名称信息。

   

3. 确认需要添加的应用机器人，单击界面添加按钮，完成机器人在飞书群中添加。

4. 参考“3 飞书群 ID 信息获取”操作，获取飞书群 ID 信息，并将其复制到运维中心 > 监控规则配置界面，在告警接收人的选择处选择飞书群。

   

3 飞书群 ID 信息获取

任务运维告警支持将飞书群作为消息接收对象，您可通过输入飞书群 ID 信息，将飞书群作为告警消息接收的对象，下文将为您介绍如何获取飞书群 ID 信息：

1. 参考“1.1 飞书应用机器人创建”章节，创建完成应用机器人。

2. 通过以下链接登录飞书应用 API 调试台：https://open.feishu.cn/api-explorer/cli_a5xxxxxxxx?apiName=create&from=op_search&project=im&resource=message&version=v1

   说明

   链接中“cli_a5xxxxxxxx”信息，需替换为您已创建的飞书应用 App ID 信息。
   

3. 进入 API 调试台界面，在左侧 API 列表导航栏中，进入消息 > 消息管理 > 发送消息调试界面。

4. 左侧导航栏中获取 API 访问凭证“tenant_access_token”参数信息，并输入 Authorization 框中用于鉴权。

5. tenant_access_token 参数信息添加完成后，上方切换至“查询参数”页签，并在“receive_id_type”下拉框中选择“chat_id”类型。

6. 单击“选择群组”按钮，在弹窗中，勾选您名下需要发送消息的飞书群组，并单击“复制群组 ID”按钮，完成飞书群 ID 信息复制。

   

7. 将获取到的飞书群 ID 信息，如：oc_xxxxxxxxxxxxxxxxxxx，复制到任务运维监控规则配置界面处，继续配置其余监控规则配置项，完成规则创建。规则配置操作详见监控规则。