diff --git a/README_zh.md b/README_zh.md index cb8a52396a600dbe96e6148e3ef349e6ad710d40..8d9db911af3780cbada4ca467b9bbf22a3926a62 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,11 +1,13 @@ # HiLog组件 -- [简介](#section11660541593) -- [目录](#section161941989596) -- [约束](#section119744591305) -- [说明](#section06487425716) - - [接口说明](#section1551164914237) - - [使用说明](#section129654513264) +- [HiLog组件](#hilog组件) + - [简介](#简介) + - [目录](#目录) + - [约束](#约束) + - [说明](#说明) + - [接口说明](#接口说明) + - [使用说明](#使用说明) + - [涉及仓](#涉及仓) - [涉及仓](#section177639411669) @@ -101,7 +103,61 @@ Debug模式输出: release模式输出: 01-26 11:01:06.870 1051 1051 W 00201/test: Failed to visit , reason:503. ``` +2. hilog命令行使用说明 + +| 选项 | 说明 | +|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| -h --help | 帮助命令 | +| -x --exit | 非阻塞读日志,读完退出 | +| 缺省 | 阻塞读日志,不退出 | +| -g | 查询buffer的大小,可配合-t使用,默认app和core | +| -p on/off, --privacy= on/off | 支持系统调试时日志隐私开关控制,显示private/明文 | +| -k on/off | Kernel日志读取开关,是/否存储kernel日志 | +| -s, --statistics | 查询统计信息,需配合-t或-D使用 | +| -S | 清除统计信息,需配合-t或-D使用 | +| -r | 清除buffer日志,配合-t指定某一类型使用,默认app和core | +| -Q control-type | 流控缺省配额开关控制 | +| pidon | 流控进程开关打开 | +| pidoff | 流控进程开关关闭 | +| domainon | 流控domain开关打开 | +| domainoff | 流控domain开关关闭 | +| -L level, --level=level | 指定级别的日志,示例:-L D/I/W/E/F | +| -t type, --type=type | 指定类型的日志,示例:-t app core init | +| -D domain, --domain=domain | 指定domain | +| -T tag, --Tag=tag | 指定tag | +| -a n, --head=n | 只显示前n行日志 | +| -z n, --tail=n | 只显示后n行日志 | +| -G size, --buffer-size=size | 设置指定type日志类型缓冲区的大小,配合-t指定某一类型使用,默认app和core | +| -P pid | 标识不同的pid | +| -e expr, --regex=expr" | 只打印日志消息与expr匹配的行,其中expr是一个正则表达式 | +| -f filename, --filename=filename | 设置落盘的文件名 | +| -l length, --length=length | 设置落盘的文件大小,大于等于64K | +| -n number, --number number | 设置落盘文件的个数 | +| -j jobid, --jobid jobid | 设置落盘任务的ID | +| -w control,--write=control | 落盘任务控制 | +| query | 落盘任务查询 | +| start | 落盘任务开始 | +| stop | 落盘任务停止 | +| -m algorithm,--stream=algorithm | 落盘方式控制 | +| none | 无压缩方式落盘 | +| zlib | zlib压缩算法落盘,落盘文件为.gz | +| zstd | zstd压缩算法落盘,落盘文件为.zst | +| 示例:hilog -w start -f "hilog" -l 66k -m zlib |解释:执行名字为hilog的落盘任务,单个文件落盘大小为66k,采用zlib压缩算法。 | | +| -v format, --format=format | | +| time | 显示本地时间 | +| color | 显示不同级别显示不同颜色,参数缺省级别颜色模式处理(按黑白方式) | +| epoch | 显示相对1970时间 | +| monotonic | 显示相对启动时间 | +| usec | 显示微秒精度时间 | +| nsec | 显示纳秒精度时间 | +| year | 显示将年份添加到显示的时间 | +| zone | 显示将本地时区添加到显示的时间 | +| -b loglevel, --baselevel=loglevel | 设置可存储日志的最低等级:D(DEBUG)/I(INFO)/W(WARN)/E(ERROR)/F(FATAL) | +``` +【注】类型、级别、域、标签支持排除查询,排除查询可以使用以\"^\"开头的参数和分隔符\",\".\n"来完成 +示例:-t ^core,app排除core和app类型的日志,可以与其他参数一起使用。 +``` ## 涉及仓 [DFX子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/DFX%E5%AD%90%E7%B3%BB%E7%BB%9F.md)