端云一体应用的日志摘要实践:用一份短摘要替代几百行日志
为什么要把日志“摘要化”
端云一体项目(鸿蒙 ArkTS 端侧 + 华为云 FunctionGraph 云函数)在联调阶段,最常见的问题不是业务逻辑写错,而是日志太多:一次完整操作会在端侧、APIG 网关、云函数三处各打一遍,排查时翻几百行才能找到关键那一行。本文整理一套本地可复现的做法:把日志按请求链路聚合、提取关键字段、生成一段短摘要,再落盘与上报。
一、统一日志结构
先约定一条日志的结构,端侧与云侧都输出同样的字段,后续才能聚合:
traceId:一次用户操作的唯一标识,端侧生成后随请求头透传;ts:毫秒时间戳,云函数统一转成东八区字符串,避免“差 8 小时”的经典问题;level:info / warn / error;module:entry / network / cloud-fn / db;msg:一句话描述,不拼接大对象;extra:小体积上下文字段(如 userId、接口路径、耗时)。
关键原则:日志行本身短,大对象只记录 id,不记录全文。
二、链路上采集
端侧(ArkTS)可以用一个轻量 Logger 单例,内部维护内存数组,最多保留 500 条环形缓冲:
class Logger {
private buf: LogItem[] = [];
private traceId: string = util.generateRandomUUID();
log(level: string, module: string, msg: string, extra?: object) {
this.buf.push({ ts: Date.now(), traceId: this.traceId, level, module, msg, extra });
if (this.buf.length > 500) this.buf.shift();
}
snapshot(): LogItem[] { return this.buf.slice(); }
}
云函数侧使用同一份结构输出到 stdout,格式为单行 JSON(不要用多行 pretty print,否则云日志里一条记录会被拆成好几段,检索困难)。
三、生成摘要
摘要的目标不是压缩原文,而是让排查时第一眼看到“发生了什么”。一个可用的摘要包含四部分:
- 链路耗时:从 entry 到最后一个 cloud-fn 响应的总毫秒数,以及各段耗时占比;
- 错误清单:所有 level=error 的 module + msg,按出现顺序去重;
- 慢点:耗时超过 800ms 的单段调用单列;
- 计数:各 module 日志条数,便于判断“日志刷屏”发生在哪一段。
实现上用一次遍历即可完成,不需要排序整个数组。示例输出:
[summary] trace=8f2c… total=1340ms entry=12% network=21% cloud-fn=61% db=6%
errors: cloud-fn/no_body_decoded, db/duplicate_key
slow: cloud-fn/createTask 910ms
counts: entry 6, network 9, cloud-fn 22, db 11
四、落盘与上报
端侧把最近一次摘要写入应用沙箱目录(context.filesDir + '/log/summary-YYYYMMDD.txt'),只保留最近 7 天,写入前按天轮转;再通过一个开关控制是否把摘要上报到云侧接口。这样既能在现场快速导出问题现场,又不会把整份日志上传。
注意事项:
- 写入要放在 IO 任务里做,不要卡主线程;
- 摘要里不要包含密码、token 等敏感字段,extra 上传前统一白名单过滤;
- 文件轮转用“先写临时文件再 rename”,避免写到一半进程被杀导致文件损坏。
五、适合什么时候用
这套做法在联调期最有用:一次工具导入、一次签到、一次列表刷新,都能拿到一页以内的摘要。对线上来说,摘要更适合作为“问题复现材料”随 Issue 附带,而不是替代完整的可观测体系(请求量、错误率、P99 延迟仍需要专门的监控面板来看)。
- 点赞
- 收藏
- 关注作者
评论(0)