「观测」使用指南|飞书低代码平台 - 飞书官网
产品功能

「观测」使用指南|飞书低代码平台

飞书

2024-12-23

功能概述​
事件列表​
检索事件​
查看详情​
事件列表详情​
事件链路​
定义​
查看事件所在链路​
查看链路上下游事件的现场​
查看流程关联的事件链路​
常见问题FAQ​
Q1:为什么函数事件看不到函数日志?如何解决?​
Q2:新版观测平台的事件存储时长是多久?​
Q3:新旧版观测系统可以来回切换么?​
功能概述​
在飞书低代码平台中,「观测」定义了 9 种事件类型,分别记录用户在和应用发生交互时,在应用内部触发的 9 种事件。如下:​
​
250px|700px|reset
image.png
​
​
​
事件类型​
说明​
OpenAPI调用​
通过调用应用的OpenAPI和用户发生交互,会被记录为一次OpenAPI调用事件。​
用户操作​
用户直接和应用页面发生交互的事件,如点击、修改输入内容等。​
页面报错​
当用户在和应用通过页面进行交互时,页面上出现用户可感知的报错出现,会被记录为一次页面报错事件。​
页面加载​
当有新的页面被应用加载时,会被记录为一次页面加载事件。​
流程执行​
当有新的流程实例被触发执行,会被记录为一次流程执行。​
函数执行​
当有新的函数实例被触发执行,会被记录为一次流程执行。​
数据流执行​
当有新的数据流执行实例被触发执行,会被记录为一次流程执行。​
鉴权​
当发生和鉴权相关的操作时,会被记录为一次鉴权事件。​
账号​
当发生和账号相关的操作时,如登录、邀请、被邀请、登出时,会被记录为账号操作事件。​
​
应用开发者可以借此排查、复现问题发生的现场,解决常见场景的自运维问题:​
  • 已发布线上的应用,出现故障时​
  • 在开发阶段预览测试的应用,出现故障时​
事件列表​
检索事件​
开发者可根据故障信息,在事件列表中对目标事件进行检索,通过设置检索时间、过滤条件、关键字方式进行检索。​
​
250px|700px|reset
image.png
​
​
查看详情​
检索到触发事件后,可点击事件查看事件详情,事件详情包含了该事件当时的完整现场记录,用以支持开发者进行现场复盘。​
​
250px|700px|reset
查看详情.gif
​
​
事件列表详情​
每个事件,均提供了不同的事件详情内容。这些内容,记录了当时的现场情况。​
  • 每个事件的详情内容如下:​
​
事件类型​
每个事件自身的详情内容​
均会提供的详情内容​
用户操作​
  • 操作人​
  • 操作类型​
  • 操作页面名称​
  • 操作页面API名称​
  • 操作控件名称​
  • 操作控件ID​
  • apaas内置UI控件JS运行日志(部分-输入/输出)​
  • 事件发生时间​
  • 事件类型​
页面加载​
  • 操作人​
  • 加载页面名称​
  • 加载页面API名称​
  • 上级页面名称(如果有)​
  • 上级页面API名称(如果有)​
  • 加载耗时(目前为TTI)​
  • 加载数据内容(脱敏后)​
  • 页面加载日志​
​
流程执行​
  • 流程名称​
  • 流程API名称​
  • 执行ID​
  • 发起方​
  • 触发方式​
  • 状态​
  • 响应码​
  • 响应描述(如果有)​
  • 耗时(从开始到结束)​
  • 流程执行概览​
  • 流程执行的节点日志​
​
函数执行​
  • 函数名称​
  • 函数API名称​
  • 是否长函数​
  • 语言​
  • 状态​
  • 耗时​
  • 触发方式​
  • 触发方​
  • 函数执行日志(即将支持,目前根据其他字段切回旧版检索函数日志)​
​
数据流执行​
  • 数据流名称​
  • 数据流API名称​
  • 执行ID​
  • 发起方​
  • 触发方式​
  • 状态​
  • 耗时​
  • 说明​
  • 执行概览​
​
鉴权​
即将支持​
​
账号​
即将支持​
​
页面报错​
​
  • 报错页面名称​
  • 报错页面ID​
  • 错误码​
  • 错误信息​
​
OpenAPI调用​
​
  • OpenAPI版本​
  • ClientID​
  • Method​
  • URI​
  • Request header/body(脱敏后)​
  • 响应码​
  • 响应头/响应体(脱敏后)​
  • 请求耗时​
​
​
事件链路​
定义​
在部分情况下,用户和应用发生一次同步交互时,会有多个事件在时间维度上被依次或同时触发,这些事件组成了一条链路,这条链路上的每个节点是一个事件。这条链路承载了当时发生应用内部在时间维度上的完整现场。​
​
250px|700px|reset
image.png
​
​
​
📌
关于「事件链路」的定义:​
一次应用交互引发的一系列同步事件。​
例如:用户操作、OpenAPI 调用、流程各种触发方式等……这些所有可导致应用响应的触发动作​
同步区别于异步。「同步事件」是指,从一次应用交互触发的所有的事件,在没有新的应用交互出现,应用不再因本次交互产生新的事件,且之前发生的事件都处于稳态。​
举个例子:​
  • 假设应用 X 流程 A 中涉及到审批场景​
  • 当用户点击了控件 C 上的按钮,触发了函数 F,函数 F 调用了流程 A,流程 A 停止在节点 N 等待审批者审批​
  • 此时如果管理员不在应用上进行审批动作,那么此时​
  • 应用 X 不再因用户的点击操作产生新的事件​
  • 目前所有的已经被触发的事件都处于稳态​
  • 用户操作事件:点击控件 C​
  • 函数执行事件:触发了函数 F​
  • 流程执行事件:函数F调用了流程 A,流程 A 停止在节点 N 等待审批者审批​
  • 那么,以上三个事件组成了一条事件链路​
​
查看事件所在链路​
开发者可先检索事件,通过事件详情页中的事件链路链接,查看该事件所在链路:​
查看链路上下游事件的现场​
当打开事件链路详情后,可通过查看上下游的事件详情,向前或向后追溯故障根因。​
​
250px|700px|reset
查看链路.gif
​
​
查看流程关联的事件链路​
从定义中可知,一个流程中可能包含多条事件链路,因此,开发者在查看流程事件详情时,如需继续查看上下游事件,可通过如下方式排查:​
  • Step1 点击流程执行事件详情页上的流程拓扑​
  • Step2 通过流程拓扑页面获取目前业务在流程实例中的流转进展和异常环节​
  • Step3 再按需查看流程触发的后续事件详情(如函数执行事件)​
常见问题FAQ​
Q1:为什么函数事件看不到函数日志?如何解决?​
原因:​
云函数需要更新到较新版的server-common的sdk(版本号在2.0.1及之后),才能支持上报函数日志到观测系统​
解决办法:​
  • 方法一:更新云函数的server-common版本,并进行部署+发布,即在新版观测平台可看到升级SDK版本后的函数日志​
​
250px|700px|reset
image.png
​
​
  • 方法二:返回旧版查看函数日志​
​
250px|700px|reset
image.png
​
​
长期解决方案:​
后续(时间待定),apaas平台会全量升级线上的server-common sdk版本,开发者无感,届时即可在新版观测平台上查询函数日志(日志范围:SDK升级后产生的函数日志)​
Q2: 新版观测平台的事件存储时长是多久?​
7天​
Q3:新旧版观测系统可以来回切换么?​
可以,新版观测系统不影响旧版观测系统功能。如图所示:​
​
250px|700px|reset
image.png
​
​
预约飞书企业效能顾问 深度诊断企业痛点,定制专属 AI 办公方案

先进团队,先用飞书

欢迎联系我们,飞书效能顾问将为您提供全力支持
分享先进工作方式
输送行业最佳实践
全面协助组织提效
标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题

字节跳动旗下 AI 工作平台

联系我们立即试用