推送日志
# 变更记录
|产品版本|更新内容|更新日期|
|-|-|-|
|V6.0.6|初始版本|2024.01.17|
---
# 1 简介
## 1.1 功能介绍
对接应用订阅了某个开放事件,当这个业务事件触发时,平台会将业务数据变化情况通过回调webhook方式传达到对接应用。推送日志功能记录了平台推送事件消息的详细记录,以便事后做日志查询、定位问题、重试补偿等。
## 1.2 面向用户
事件消费者
## 1.3 应用场景
1、事件推送数据统计和分析。
2、事件订阅出错时,查询日志做错误定位和推送手工重试。
## 1.4 系统路径
【开放服务云】-【OpenAPI】-【开放事件】-【推送日志】
## 1.5 关键字段/按钮说明
### 1.5.1 字段说明
| 字段名称 | 字段说明 |
| ------------ | ------------------------------------------------------------ |
| 件执行时间 | 事件推送订阅开始执行的时间 |
| 实例ID | 订阅执行实例ID |
| 状态 | 订阅执行的状态,分为成功,失败
成功:推送时回调业务方响应正常,未超时未报错则判定为订阅推送成功
失败:推送时回调业务方响应超时或者响应报错,则判定为订阅推送失败 | | 订阅名称 | 执行的事件推送订阅名称 | | 触发事件编码 | 触发事件编码 | | 触发事件 | 触发事件名称 | | 推送时间 | 真正调用回调业务方的时间
如果有重试的话,推送时间展示的是最后一次重试的时间 | | 回调业务方 | 事件触发时回调的业务方 | | 回调地址 | 事件触发时回调的业务方地址 | | 日志详情 | 事件推送订阅执行报错的详细报错信息 | | 推送数据 | 调用回调地址的请求参数 | | 返回信息 | 请求回调地址返回的数据 | ### 1.5.2 按钮说明 | 按钮名称 | 按钮说明 | | -------- | ------------------------------------------------------------ | | 手工重试 | 用户可勾选失败的日志进行手工重试,系统用该事件数据重新请求一次回调地址。
同时日志记录会刷新展示最新一次重试的执行结果。 | # 2 主要操作 ## 2.1 日志查询 进入推送日志列表,可通过执行时间、实例ID、状态、触发事件编码、触发事件、回调业务方等多字段进行搜索查询事件推送日志。 ![image-20240108144621310.webp](/download/0100a75ff1f79ddb4664a7856cc985392579.webp) ## 2.2 日志详情 点击某条日志记录执行时间,进入日志详情页面。 1)基本信息:实例ID、状态、事件编码、事件名称、订阅名称、推送时间、回调业务方、回调地址等信息 2)事件推送订阅执行实例数据: - 日志详情:若订阅执行报错,此处显示执行报错信息,便于定位问题;若订阅执行成功,此处显示运行容器实例(InstanceId)和TraceId,方便调用全链路追踪。 - 推送数据:展示调用的请求参数。 - 返回信息:展示回调的响应结果,当订阅执行失败时,此处为空。 ![image-20240108145749376.webp](/download/010026e44257782944e19311d4b82b5c6285.webp) ![image-20240108145813996.webp](/download/01005a24d1e4ed9a4c6cbd24b4a38e35cf84.webp) ## 2.3 手工重试 勾选失败状态的日志记录,点击“手工重试”按钮显示二次确认的弹窗,用户二次确认后,系统会再次推送事件消息到对应的回调地址,执行完毕后当前日志记录会刷新,展示最新一次推送的详细数据和执行结果。 *注意:对于一个订阅实例,重试后列表上不会显示两条日志记录,而是刷新原来的记录展示最新一次推送的详细日志。*
# 3 注意事项 1、单条日志“日志详情”和“返回信息”字段长度默认截取2000个字符,如需设置存储更长的日志请请联系管理员去修改应用参数。
成功:推送时回调业务方响应正常,未超时未报错则判定为订阅推送成功
失败:推送时回调业务方响应超时或者响应报错,则判定为订阅推送失败 | | 订阅名称 | 执行的事件推送订阅名称 | | 触发事件编码 | 触发事件编码 | | 触发事件 | 触发事件名称 | | 推送时间 | 真正调用回调业务方的时间
如果有重试的话,推送时间展示的是最后一次重试的时间 | | 回调业务方 | 事件触发时回调的业务方 | | 回调地址 | 事件触发时回调的业务方地址 | | 日志详情 | 事件推送订阅执行报错的详细报错信息 | | 推送数据 | 调用回调地址的请求参数 | | 返回信息 | 请求回调地址返回的数据 | ### 1.5.2 按钮说明 | 按钮名称 | 按钮说明 | | -------- | ------------------------------------------------------------ | | 手工重试 | 用户可勾选失败的日志进行手工重试,系统用该事件数据重新请求一次回调地址。
同时日志记录会刷新展示最新一次重试的执行结果。 | # 2 主要操作 ## 2.1 日志查询 进入推送日志列表,可通过执行时间、实例ID、状态、触发事件编码、触发事件、回调业务方等多字段进行搜索查询事件推送日志。 ![image-20240108144621310.webp](/download/0100a75ff1f79ddb4664a7856cc985392579.webp) ## 2.2 日志详情 点击某条日志记录执行时间,进入日志详情页面。 1)基本信息:实例ID、状态、事件编码、事件名称、订阅名称、推送时间、回调业务方、回调地址等信息 2)事件推送订阅执行实例数据: - 日志详情:若订阅执行报错,此处显示执行报错信息,便于定位问题;若订阅执行成功,此处显示运行容器实例(InstanceId)和TraceId,方便调用全链路追踪。 - 推送数据:展示调用的请求参数。 - 返回信息:展示回调的响应结果,当订阅执行失败时,此处为空。 ![image-20240108145749376.webp](/download/010026e44257782944e19311d4b82b5c6285.webp) ![image-20240108145813996.webp](/download/01005a24d1e4ed9a4c6cbd24b4a38e35cf84.webp) ## 2.3 手工重试 勾选失败状态的日志记录,点击“手工重试”按钮显示二次确认的弹窗,用户二次确认后,系统会再次推送事件消息到对应的回调地址,执行完毕后当前日志记录会刷新,展示最新一次推送的详细数据和执行结果。 *注意:对于一个订阅实例,重试后列表上不会显示两条日志记录,而是刷新原来的记录展示最新一次推送的详细日志。*
# 3 注意事项 1、单条日志“日志详情”和“返回信息”字段长度默认截取2000个字符,如需设置存储更长的日志请请联系管理员去修改应用参数。
推送日志
# 变更记录|产品版本|更新内容|更新日期||-|-|-||V6.0.6|初始版本|2024.01.17|---# 1 简介## 1.1 功能介绍对接应用订阅了某个开放事件...
点击下载文档
本文2024-09-23 00:54:08发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-142479.html
您需要登录后才可以发表评论, 登录登录 或者 注册
最新文档
热门文章