跳转至

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

前提条件

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

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

飞书版本：7.5.34 及以上版本

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

部署Func脚本

安装脚本集

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

image-20240625175051160

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

image-20240703182115395

image-20240703182213897

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

image-20240628111425215

进入PIP工具页面后点击安装“lark-oapi==1.2.8”，并等待安装完成

image-20240703182320511

image-20240703182412031

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

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

image-20240703182532044

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

获取CALLBACK_URL

1.点击管理，打开“授权链接”（新版本中为“同步API”）页面，点击新建

Create-Authorization-Link

按下图配置函数，并保存

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

image-20240703182728826

保存后，自动返回授权链接页面，找到启用的webhook函数，点击示例

image-20240703182839374

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

image-20240703183037477

image-20240703184222016

创建飞书应用

获取APP_KEY、APP_SECRET

登录开发者后台

登录并打开「飞书开发者后台」，并通过「飞书账号」进行登录，选择所属【飞书企业】

image-20240703183231907

image-20240703183329871

创建企业自建应用

打开「企业自建应用」并点击「创建企业自建应用」按钮

image-20240703183522800

选择企业自建应用

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

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

image-20240703183849152

获取应用凭证

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

image-20240703184008035

根据如下位置找到脚本的位置：开发->脚本库->观测云异常追踪-飞书,并填入如下位置

image-20240703184342387

添加应用能力-机器人

在飞书应用详情页的左侧导航栏点击「应用功能-添加应用能力」，点击添加「机器人」即可

image-20240703184731165

image-20240703184745062

配置事件与回调

在飞书应用详情页的左侧导航栏点击「开发配置-事件与回调」，点击「事件配置」点击「订阅方式」编辑按钮

image-20240703184947913

选择“将事件发送至开发者服务器”，并将Func配置文件CALLBACK_URL参数填入“请求地址”后，点击保存

image-20240703185412672

点击左下角“添加事件”按钮，找到并勾选“接收消息”，点击“确认添加”

image-20240702163337950

添加事件后，记录下列表中该事件所需开通的权限

image-20240702165540607

完成事件配置后，点击“回调配置”中的“添加回调”，勾选“卡片”-“卡片回传交互”，点击“确认添加”

image-20240702163146043

权限配置

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

勾选并批量开通如下权限：

  • 以应用的身份发消息
  • 获取用户邮箱信息
  • 获取用户基本信息
  • 获取通讯录基本信息
  • 获取用户 user ID

image-20240705155835861

image-20240705155857361

image-20240705155937247

image-20240709170716665

image-20240709170817811

image-20240703191017916

发布飞书应用

上述操作完成后，在飞书应用详情页的左侧导航栏点击「应用发布-版本管理与发布」，点击“创建版本”

image-20240705165804936

在“版本详情”页面中，填写以下关键字段后，点击“保存”，即可完成“应用发布”

  • 应用版本号：根据版本号顺延一般首个版本填写为1.0.1
  • 移动端的默认能力：机器人
  • 桌面端的默认能力：机器人
  • 更新说明：版本发布（填写变更内容）
  • 可用范围：如无特殊范围要求则选择“所有员工”

image-20240705165648276

配置飞书卡片

获取AT_CARD_ID、TRACE_CARD_ID、REPLY_CARD_ID

下载卡片模板

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

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

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

导入飞书卡片

打开链接进入“飞书卡片搭建工具”页面：https://open.feishu.cn/cardkit

点击“导入卡片”，并将“异常追踪卡片”，“异常追踪消息回复卡片”，“异常追踪通知信息卡片”分别上传导入。

image-20240704191739904

导入完成后，进入卡片配置页面，选择“机器人图标”，“添加自定义机器人/应用”，点击“+”选择应用

image-20240704191940030

点击选择“观测云异常追踪助手”，并点击确定

image-20240704192017232

发布飞书卡片

随后点击右上角“发布”按钮，发布卡片

image-20240704191735324

image-20240704191806833

image-20240704192059654

获取卡片ID

发布完成后，分别点进3张卡片，在左上角复制卡片id，并分别填写到Func平台的config文件的对应参数中

image-20240704192626466

image-20240704192833634

配置飞书群机器人

添加上述步骤后，我们在群里启用机器人，如下图

image-20240702165207025

image-20240702165259241

搜索应用名称点击添加

image-20240702165322347

创建观测云工作空间API_KEY

获取DF_API_KEY

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

image-20240625173106819

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

image-20240625173113311

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

image-20240704193247524

配置异常追踪通知地址

获取通知地址

安装好机器人后，请在群内@对应的机器人，机器人会返回如下图所示的信息，进行复制

image-20240702171245188

配置观测云通知对象

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

image-20240625173251061

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

image-20240625173257234

配置频道通知对象

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

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

image-20240625173304350

测试验证

新建issue

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

image-20240705171447612

卡片创建通知

回到飞书群，看到下列信息代表成功

image-20240705171354745

异常追踪测试操作

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

飞书卡片不支持未绑定邮箱的飞书用户进行操作，可前往“飞书管理后台”-“组织架构”-“成员与部门”中绑定成员邮箱

观测云免费工作空间不支持由空间外部成员的邮箱账号受理或解决ISSUE

受理

当你点击受理时，代表将您的飞书账号信息更新为该ISSUE的负责人，并且会将受理信息同步通知到飞书群中

image-20240705171354745

解决

将issue的状态更新为resolved，并且会将解决恢复信息同步通知到飞书群中

image-20240705172007462

回复/追加回复

针对该条issue进行回复，并且会将回复内容同步通知到飞书群中

image-20240705172141122

查看详情

点击“详情”按钮后会跳转到观测云当前issue的详情弹窗页面

image-20240705172331212