流程执行日志|飞书低代码平台

流程执行日志|飞书低代码平台

飞书低代码平台手册精选NaN-NaN-NaN
产品功能
功能概述
每次流程执行都会生成一次流程执行历史的记录,在「流程执行历史」中可以查看每个流程的历史运行情况的列表,供开发者进行调试或排障运维,可快速定位应用搭建和运行时流程的问题。
查询入口
💡
在开发环境中,查看到的流程执行历史均为开发环境的执行记录;
在线上环境中,查看到的是线上环境的执行记录,两个环境中查看执行历史的入口和方法相同,下面统一介绍。
切换环境的入口如下:
250px|700px|reset
image.png
每个环境中,查看流程执行历史有三个入口:
  1. 进入开发应用后台 :观测 -> 事件列表 -> 流程执行。
从该入口进入流程执行历史,可以查看应用包内所有流程的执行记录。
使用场景举例:想查看应用包内流程的整体执行情况或仅知道执行 ID 而不知道是哪个流程时。
250px|700px|reset
image.png
  1. 开发应用后台 -> 流程管理 -> 进入流程画布 -> 执行历史。
从该入口进入流程执行历史,仅支持查看当前流程的执行历史。
使用场景举例:明确知道需要查看哪个流程的执行历史时。
250px|700px|reset
image.png
  1. 开发应用后台 -> 流程管理 -> 点击流程操作的「...」-> 查看执行历史 -> 跳转「日志」的流程执行历史。
使用场景举例:明确知道需要查看哪个流程的执行历史时。
250px|700px|reset
image.png
综上,将分别介绍进入「日志的流程执行历史」和「画布执行历史」后,该如何具体查看执行记录。
日志概述
流程执行历史
流程真实运行后的一个执行记录,对应一个「执行 ID」,查看的位置如下:
  1. 流程 >> 编辑页面 >> 历史
250px|700px|reset
image.png
观测 >> 流程执行
250px|700px|reset
image.png
流程执行概览
流程中每个节点运行的概要信息,主要包括:节点执行的状态、起始时间、耗时,以及节点业务逻辑执行的结果
250px|700px|reset
image.png
流程历史配置
流程运行时会记录其配置数据,包括流程拓扑、流程变量、每个节点的详细配置
  • 只能通过「流程拓扑」功能进行查看
250px|700px|reset
image.png
250px|700px|reset
image.png
注意:线上环境的流程日志需要提前在「应用监控 >> 流程日志中配置」
250px|700px|reset
image.png
流程执行日志
流程执行日志是一个流程中用户所需的全部数据,主要包括:
  • 每个节点消费的入参变量与出参变量值
  • 节点配置(尤其是引用变量或是使用公式)的运行时真实值
  • 函数日志
  • 涉及 HTTP 请求的连接器真实的请求响应原文
位置一:流程列表中点击单行即可展示,支持整个流程详细日志的关键组搜索
250px|700px|reset
image.png
位置二:历史拓扑
在流程历史拓扑页面中,可以结合一次流程运行的流程配置数据和运行后每个节点的日志信息进行问题排查
250px|700px|reset
image.png
注意:线上环境需要提前在「应用监控 >> 流程日志中配置」
250px|700px|reset
image.png
支持查看调用的「函数-运行日志」
  • 点击「调用函数」的流程,在流程执行日志侧拉窗中,点击「调用函数」节点的「查看日志」即可直接跳转到对应函数执行日志中
  • 查看入口:
250px|700px|reset
image.png
  • 操作演示:
适用场景
开发过程进行流程调试
250px|700px|reset
image.png
线上故障后进行排障运维
  1. 发现故障:报出超时错误
250px|700px|reset
  1. 排查问题:根据错误信息和历史配置发现超时时间可能配置不当
250px|700px|reset
  1. 排除问题并测试:在开发环境修改配置并测试通过
250px|700px|reset
使用方式
流程日志
(一)管理员配置日志打印开关
📌
仅线上环境的日志打印需要手动开启
开发环境运行的所有流程默认支持,不需要额外配置
  1. 应用管理员进入「应用监控」页面。
250px|700px|reset
image.png
  1. 在「流程日志设置」中开启开关,开关开启流程运行才会打印日志,开关开启前运行的流程不会打印详细日志。
250px|700px|reset
image.png
  1. 在「设置流程范围」中配置需要开启日志打印的流程范围,支持选择对全部流程或对部分流程开启打印。
250px|700px|reset
设置流程范围.gif
(二)管理员配置日志查看授权
📌
授权配置仅作用于线上环境,沙箱环境的日志查看无需手动授权
开发环境运行的所有流程默认支持,不需要额外配置
  1. 应用管理员进入「应用监控」页面
  1. 创建「业务数据授权」
250px|700px|reset
image.png
  1. 进行授权配置
详细的配置步骤请查看:敏感数据查看授权
  1. 指定成员:授权的人员对象,可以是多个成员
  1. 指定授权范围:当选择「指定流程」时,该组授权的成员将无法看到其他流程的详细日志
  1. 授权有效期:授权有效的日期范围
  1. 脱敏查看:该组授权人员查看的日志是否需要针对敏感数据进行脱敏,详见「高级用法-日志敏感字段脱敏」
250px|700px|reset
image.png
(三)开发者查看流程日志
📌
对于线上环境使用的前置条件(开发环境无需以下条件)
  1. 流程管理员开启了该流程的详细日志打印开关
  1. 流程管理员给开发者授予了查看该流程详细日志的权限
  1. 在日志 >> 流程执行历史列表中查看
支持关键字搜索、日志等级筛选等操作
250px|700px|reset
image.png
  • 列表内每一行为某个流程的某一次执行,流程执行历史列表的各字段介绍如下表所述。
字段名
解释说明
发起时间
流程该次执行的开始时间。时间格式为:年-月-日 时-分-秒
名称
流程的名称
状态
流程该次执行的执行状态。共 6 种流程执行状态:排队中/进行中/失败/已完成/已撤销/已终止
响应码
流程返回的响应码。系统默认在成功时返回 0,失败时返回相应错误码
耗时
该次执行的耗时时长。流程处于排队中和进行中状态时不显示
说明
对某些流程执行结果的说明,例:审批结果、失败原因等信息
发起人
流程的发起人。非人为发起的流程,发起人为「系统」
执行 ID
流程每次执行的唯一标识。通常在发现系统异常类型的错误时,通过执行 ID 来排查问题
  • 流程执行历史列表支持搜索,可根据时间范围、状态、来源、发起人等方式筛选。
250px|700px|reset
image.png
  • 自定义列:可以根据个人使用需求配置列表头字段显示数量和顺序。
250px|700px|reset
image.png
功能
说明
备注
搜索
可通过流程名称、执行 ID 、响应码搜索
搜索后展示包含搜索关键字的所有流程执行记录
时间选择器
可设置时间范围筛选指定时间段内产生的流程执行记录
  • 默认展示近 7 天内的记录
  • 开始时间不能晚于结束时间
筛选器
可按照状态、来源和发起人、响应码四个维度筛选符合条件的执行记录
  • 各个筛选维度均可多选
  • 确定后将显示满足所有所设筛选条件的执行记录
  • 点击清除后会将所有筛选条件清空
刷新
列表不会动态自动刷新,需要获取最新记录列表时可以点击手动刷新
--
自定义列
自定义配置列表显示字段,调整字段顺序
-
  1. 在流程画布中查看
  1. 点击「历史」会弹出该流程执行的列表
  1. 点击「历史」中的一行会弹出该流程运行记录的侧拉窗
  1. 点击「日志」Tab 可以查看该流程执行记录的详细日志,支持关键字搜索、日志等级筛选等操作
250px|700px|reset
image.png
  1. 在流程历史拓扑中查看
  1. 点击「历史」可以查看到该流程执行的概览数据
  1. 在侧拉窗中点击任意一个节点将展示每个节点的详细日志数据,支持切换至其他节点
250px|700px|reset
流程历史拓扑.gif
流程历史拓扑
(一)进入历史拓扑页
  1. 从流程执行记录的详情中进入
  1. 流程列表的详情侧拉窗
250px|700px|reset
image.png
  1. 流程画布的详情侧拉窗
250px|700px|reset
image.png
(二)查看历史配置信息
查看该次流程执行所使用流程拓扑和每个节点的配置信息
250px|700px|reset
image.png
(三)查看节点详细的执行数据
📌
对于线上环境使用的前置条件(开发环境无需以下条件)
  1. 流程管理员开启了该流程的详细日志打印开关
  1. 流程管理员给开发者授予了查看该流程详细日志的权限
  1. 点击右侧侧拉窗中的某个节点
250px|700px|reset
image.png
  1. 查看该节点详细的日志数据,包括节点出入参、配置的运行时实际值、连接器原始的 HTTP 请求响应原文档等
250px|700px|reset
image.png
高级用法
日志敏感字段脱敏
(一)敏感字段定义
在「数据 >> 对象」中对敏感字段开启「加密存储」
250px|700px|reset
image.png
(二)管理员在授权配置中开启脱敏
250px|700px|reset
image.png
(三)开发者查看脱敏后的日志内容
250px|700px|reset
image.png
250px|700px|reset
image.png
先进生产力和业务协同平台
联系我们立即试用

先进团队,先用飞书

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