diff --git a/README_zh.md b/README_zh.md index cb8a52396a600dbe96e6148e3ef349e6ad710d40..a989df9fdad98d3910f1dd3a5bffe1f7e71aeb7f 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,11 +1,13 @@ # HiLog组件 -- [简介](#section11660541593) -- [目录](#section161941989596) -- [约束](#section119744591305) -- [说明](#section06487425716) - - [接口说明](#section1551164914237) - - [使用说明](#section129654513264) +- [HiLog组件](#hilog组件) + - [简介](#简介) + - [目录](#目录) + - [约束](#约束) + - [说明](#说明) + - [接口说明](#接口说明) + - [使用说明](#使用说明) + - [涉及仓](#涉及仓) - [涉及仓](#section177639411669) @@ -101,6 +103,71 @@ 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 | +| -G | --buffer-size | \ | 设置指定\日志类型缓冲区的大小,配合-t指定某一类型使用,默认app和core, 可使用B/K/M/G为单位 | +| -r | | | 清除buffer日志,配合-t指定某一类型使用,默认app和core | +| -p | --privacy | | 支持系统调试时日志隐私开关控制 | +| | | on | 打开隐私开关,显示\ | +| | | off | 关闭隐私开关,显示明文 | +| -k | | | Kernel日志读取开关控制 | +| | | on | 打开读取kernel日志 | +| | | off | 关闭读取kernel日志 | +| -s | --statistics | | 查询统计信息,需配合-t或-D使用 | +| -S | | | 清除统计信息,需配合-t或-D使用 | +| -Q | | \ | 流控缺省配额开关控制 | +| | | pidon | 进程流控开关打开 | +| | | pidoff | 进程流控开关关闭 | +| | | domainon | domain流控开关打开 | +| | | domainoff | domain流控开关关闭 | +| -L | --level | \ | 指定级别的日志,示例:-L D/I/W/E/F | +| -t | --type | \ | 指定类型的日志,示例:-t app core init | +| -D | --domain | \ | 指定domain | +| -T | --Tag | \ | 指定tag | +| -a | --head | \ | 只显示前\行日志 | +| -z | --tail | \ | 只显示后\行日志 | +| -P | --pid | \ | 标识不同的pid | +| -e | --regex | \ | 只打印日志消息与\匹配的行,其中\是一个正则表达式 | +| -f | --filename | \ | 设置落盘的文件名 | +| -l | --length | \ | 设置落盘的文件大小,需要大于等于64K | +| -n | --number | \ | 设置落盘文件的个数 | +| -j | --jobid | \ | 设置落盘任务的ID | +| -w | --write | \ | 落盘任务控制 | +| | | query | 落盘任务查询 | +| | | start | 落盘任务开始,命令行参数为文件名、单文件大小、落盘算法、rotate文件数目. | +| | | stop | 落盘任务停止 | +| -m | --stream | \ | 落盘方式控制 | +| | | none | 无压缩方式落盘 | +| | | zlib | zlib压缩算法落盘,落盘文件为.gz | +| | | zstd | zstd压缩算法落盘,落盘文件为.zst | +| -v | --format | \ | | +| | | time | 显示本地时间 | +| | | color | 显示不同级别显示不同颜色,参数缺省级别颜色模式处理(按黑白方式) | +| | | epoch | 显示相对1970时间 | +| | | monotonic | 显示相对启动时间 | +| | | usec | 显示微秒精度时间 | +| | | nsec | 显示纳秒精度时间 | +| | | year | 显示将年份添加到显示的时间 | +| | | zone | 显示将本地时区添加到显示的时间 | +| -b | --baselevel | \ | 设置可打印日志的最低等级:D(DEBUG)/I(INFO)/W(WARN)/E(ERROR)/F(FATAL) | + +``` +示例:hilog -G 2M -t core +解释:设置buffer大小为2M,日志类型为core。 +示例:hilog -g -t app +解释:查询日志类型为app的buffer大小。 +示例:hilog -w start -f "hilog" -l 66k -m zlib -n 10 +解释:执行名字为hilog的落盘任务,10个落盘文件进行轮转,单个文件落盘大小为66k,采用zlib压缩算法。 +type、level、domain、tag支持排除查询,排除查询可以使用以"^"开头的参数和分隔符","."来完成 +示例:hilog -t ^core,app 排除core和app类型的日志,可以与其他参数一起使用。 +示例:hilog -t app core 打印core和app类型的日志,可以与其他参数一起使用。 +``` ## 涉及仓