数据上报验证

最近更新时间:2025-10-17 18:56:51

我的收藏
SDK 支持业务主动调用上报接口,上传自定义日志、文件等信息。该功能可用于用户反馈、异常发生等场景及时上报本地日志信息,帮助保留问题现场。

下发指令

平台提供日志捞取指令的下发能力。
用户可以在平台管理端的 日志 > 日志查询 > 下发指令 页面进行指令的下发和上报结果查询。通过 新建查询 入口,新建一个日志捞取命令,捞取命令需选择捞取日志的时间范围设备唯一ID,支持为捞取增加搜索标签和附件路径。
注意:
捞取时指定的设备ID即 TDDiag.setGuid 时设置的 Guid。

待命令下发后,可等待 SDK 拉取配置,并上传对应的日志文件。

配置拉取

下发命令后,依赖 SDK 本地的配置拉取逻辑来判断是否有日志需要上报。
配置拉取时机
调用 TDDiag.setGuid。
后台默认返回下一次配置拉取6分钟间隔,本地每5分钟检查是否满足间隔时间,满足则拉取。
配置强制拉取
一般情况下,上述时机可以确保日志指令被及时接收并上传日志 ,但特殊场景下,用户可以选择调用如下接口来主动拉取配置。
TDDiag.syncConfig(true); // 强制拉取配置,参数设置为true为强制刷新,不检查是否满足后台默认时间间隔;参数为false则仍会检查是否满足时间间隔条件

主动上报

上报限制

调用主动上报接口时,请关注接口相关限制。
主动上报接口存在限频,默认每5分钟内最多进行2次上报。
主动上报存在每日总配额500M限制(文件压缩后),每日额度采用令牌桶算法逐步递增,支持在 TDDiag 初始化时使用 xgTrafficQuota 参数设置500M流量的每日上报额度。
可在 TDDiag 初始化时配置 initiativeUploadWhiteListTags 参数来设置忽略上报限制的标签,满足白名单标签的主动上报不受前两点的限制。
主动上报存在熔断机制,如果连续上报失败10次后,将停用上报6小时。
主动上报打包上传前,会检查压缩前的文件大小。如果压缩前超过500M则不会被打包上报,请控制单次上报文件大小。
上报日志文件支持多路径设置,路径支持设置目录或文件。

上报方式

参考如下代码主动上报日志文件或自定义文件。
import { TDDiag, TDDiagUploadParams } from 'rumPro';

public static uploadFiles() {
// 1、构建上报参数
let params = new TDDiagUploadParams();
params.files = logPathArr; // 需上报的日志文件或自定义文件路径,传入文件list数组
params.tag = "xxx"; // 主动上报标签
params.summary = "xxx"; // 主动上报信息摘要
params.extraInfo = "xxx"; // 主动上报附带的扩展信息
params.queryKey = "test_key"; // 主动上报的查询key,可在rumPro平台日志查询页面,直接在url后拼接 &key=test_key 检索对应的上报,key值可由业务自行定义


// 2、调用上报接口
TDDiag.uploadLogFiles(params);
}


上报查看

上传后可在平台管理端的 日志 > 日志查询 > 主动上报 页查看上报的日志信息。