跳转至

观测云异常追踪-钉钉集成配置

前提条件

提示：

在配置前，请确保你具备「观测云工作空间」和「钉钉开放平台」的管理权限。

已安装Func部署版 或 已开通观测云Func托管版

钉钉版本：7.5.34 及以上版本

Func版本：5.x 及以上版本

部署Func脚本

安装脚本集

登录并访问Func平台，点击“脚本市场”-找到“官方脚本市场”，点击“进入”

image-20240625175051160.png

在右上角输入“观测云异常追踪-钉钉”进行检索，找到“观测云异常追踪-钉钉”脚本，点击安装并确认

image-20240628111203148

image-20240628111311694

等待脚本集安装，弹窗提示成功安装脚本集后，点击前往PIP工具 链接，安装第三方依赖包。

image-20240628111326117

image-20240628111425215

进入PIP工具页面后点击安装，并等待安装完成

image-20240628111909315

image-20240628111947300

安装成功后，点击开发，检索“观测云异常追踪-钉钉”，找到脚本集中的config并打开

该脚本中的配置参数需要通过后续的功能开通进行获取

image-20240628112451359

新建 Func 同步 API（旧版：授权链接）

获取CALLBACK_URL

1.点击管理，打开同步 API（旧版：授权链接）页面，点击新建

Create-Authorization-Link

第二步：按下图配置函数，并保存

  • 执行函数：检索并选择：观测云异常追踪-钉钉 / guance_issue_dingtalk__callback / webhook，确认后点击保存

image-20240628112641279

保存后，自动返回同步 API（旧版：授权链接）页面，找到启用的 webhook 函数，点击示例

image-20240628112744381

点击POST简化形式（表单），复制框选中链接部分，并黏贴至 Func 配置文件 CALLBACK_URL 参数中

image-20240628112821682

创建钉钉应用

获取APP_KEY、APP_SECRET

登录「钉钉开放平台」

打开「钉钉开放平台」并通过「钉钉账号」进行登录，选择所属【钉钉组织】

image-20240625172837840.pngimage-20240625172854344.png

创建企业内部应用

打开「企业内部开发-钉钉应用」并点击「创建应用」

image-20240625172903290

点击「创建应用」按照以下提供的信息创建应用

  • 应用名称：观测云异常追踪助手
  • 应用描述：现代化的监控观测云服务，统一满足云、云原生、应用及业务上的监测需求
  • 应用图标：image-20240625172915129.png

image-20240625172933731

获取应用凭证

完成创建后，页面会自动跳转到应用详情页。找到应用详情页「基础信息」，点击「凭证与基础信息」将「AppKey、AppSecret」信息复制并黏贴至Func配置文件中。

image-20240625172940749

添加应用能力-机器人

在钉钉应用详情页的左侧导航栏点击「应用功能-添加应用能力」，添加「机器人」后填写以下信息后发布

机器人名称：点击「使用应用名称」

•机器人图标：点击「使用应用图标」

•机器人简介：观测云异常追踪助手

•机器人描述：现代化的监控观测云服务，统一满足云、云原生、应用及业务上的监测需求

•机器人消息预览图：image-20240625172950996

•消息接收模式：HTTP模式

•消息接收地址：(根据每个企业单独生成，请复制Func配置文件中的CALLBACK_URL参数地址)

image-20240625172959253

image-20240625173005061

权限配置

在钉钉应用详情页的左侧导航栏点击「开发配置-权限管理」，配置以下信息并批量申请权限

  • 权限范围：全部员工

注意： 集成启用后，观测云异常追踪 助手讲根据钉钉应用中「权限范围」向用户发送授权邀请消息； 如果整个企业将正式启用 钉钉集成：可选全部员工； 如果仅个别部门开始使用：可选部分员工，勾选使用员工或部门； 如果当前是仍在试用阶段，可选仅限当前操作人自己。

  • 权限信息
  • 通讯录个人信息读权限
  • 通讯录组织基础信息读权限
  • 企业内机器人发送消息权限
  • 成员信息读权限
  • 钉钉群基础信息管理权限
  • 邮箱等个人信息

发布应用

选择版本管理与发布，创建一个新版本

image-20240625173016729

输入如下信息，点击保存后，确认直接发布，即可完成应用发布上线

  • 应用版本号：1.0.0（根据当前版本自动递增）
  • 版本描述：可自定义版本描述内容
  • 应用可选范围：全部员工（根据需求选择可用范围）

image-20240625173024664

配置卡片模板

获取AT_CARD_ID、TRACE_CARD_ID、REPLY_CARD_ID

下载卡片模板

异常追踪配置卡片：ISSUE_AT_CARD.json

异常追踪信息卡片：ISSUE_TRACE_CARD.json

异常追踪回复卡片：ISSUE_REPLY_CARD.json

新建卡片模板

找到钉钉开放平台「开放能力」，选择进入「卡片平台」页面并点击「新建模板」

需要创建并导入3个卡片模板，下文以“观测云异常追踪”卡片为例

image-20240625173032418

点击「新建模板」按照以下提供的信息创建应用

  • 模板名称：观测云异常追踪
  • 卡片类型：消息卡片
  • 卡片模板场景：普通卡片
  • 关联应用：「观测云异常追踪助手」

image-20240625173040493

导入卡片模板

完成创建后，页面会自动跳转到卡片详情页。找到「更多」，点击「导入模板」

image-20240625173047158

保存卡片模板

选择下载的「观测云异常追踪」卡片模板，保存后，点击返回卡片列表页面

image-20240625173053745

获取卡片模板ID

点击「模板ID」将「模板ID」信息复制并黏贴至Func配置文件TRACE_CARD_ID参数中。

image-20240625173059334

创建观测云工作空间API_KEY

获取DF_API_KEY

打开观测云-管理-API Key管理，点击新建Key，命名：Func异常追踪

image-20240625173106819

完成key创建后，复制key值到Func配置文件DF_API_KEY参数中

image-20240625173113311

完成Func config文件中参数填写后，点击”发布“，即完成脚本参数配置

image-20240625180320299

注册钉钉互动卡片回调地址

每次修改CALLBACK_URL这个配置之后，都需要将下述步骤重新执行

在Func配置文件配置完成之后，需要先按下图进行回调地址注册

1.找到“观测云异常追踪-钉钉”-“注册回调地址”脚本，点击“编辑”

image-20240628112942798

2.进入编辑模式后，选择“def register”，点击“执行”，返回“注册成功”即完成回调地址的注册

image-20240628113016880

配置观测云通知地址

创建钉钉群机器人

1.配置观测云通知地址之前，需要先打开钉钉，将之前应用打开的机器人配置到群里，点击配置

选择需要启用观测云异常追踪通知的钉钉群，并点击右上角设置图标，找到机器人选项，并点击进入后选择 添加机器人

image-20240625173142017.png image-20240625173142017.png

在弹窗中找到 创建的机器人，并点击添加

image-20240625173220810.png image-20240625173225503.png

完成机器人添加后，机器人在群消息中发送消息，即完成群中机器人的添加

image-20240625173233657

获取通知地址

在群消息中@机器人，将会以消息卡片的方式提供，通知地址（该通知地址用于接收观测云异常追踪消息通知）

image-20240625173240306

配置观测云通知对象

复制上述的地址，打开观测云，按下述步骤配置到观测云-通知对象中

image-20240625173251061

对通知对象进行命名并填入通知地址，点击保存即完成通知对象的创建

image-20240625173257234

配置频道通知对象

频道管理配置代表你可以根据不同的频道选择将不同的issue通知到不同的钉钉群，配置规则如下

进入观测云 ->点击异常追踪 ->频道管理->通知 根据自己的需求将之前配置的通知对象放入即可

image-20240625173304350

测试验证

1.新建issue

根据上述步骤完成之后就可以去异常追踪那进行测试了 在观测云按照下面的顺序点击：异常追踪->新建issue

image-20240625173312108

2.互动卡片创建通知

如果上述步骤正常，当你在点击保存的时候，就会往你配置的群里面打一条告警信息

image-20240625173317681

异常追踪测试操作

钉钉群里的消息卡片共有四个功能：受理、解决、回复、详情，接下来分别对这些功能进行进一步的解析

免费空间不支持由外部账号受理或解决ISSUE

受理

当你点击受理时代表将当前点击人更新到负责人上，并且会往该群内重新打一条告警

image-20240625173326675

解决

将issue的状态更新为resolved，并往钉钉群内打一条信息，并且会在回复中新增一条信息，按钮会只能进行回复

image-20240625173334384

回复/追加回复

针对该条issue进行回复，并且会打出回复卡片

image-20240625173344055

查看详情

点击后会跳转到观测云当前issue的页面

image-20240625173349322