diff --git a/zh-cn/application-dev/dfx/hilog-guidelines-ndk.md b/zh-cn/application-dev/dfx/hilog-guidelines-ndk.md index 03ccc1bb4c059ff0cd45e67430cad9dc8c028c9b..b8afd5c3b9e9d1ef0ec609aa2cc53d3a9a04232b 100644 --- a/zh-cn/application-dev/dfx/hilog-guidelines-ndk.md +++ b/zh-cn/application-dev/dfx/hilog-guidelines-ndk.md @@ -40,10 +40,10 @@ HiLog中定义了DEBUG、INFO、WARN、ERROR、FATAL五种日志级别，并提 | 格式说明符（specifier） | 说明 | 示例 | | -------- | -------- | -------- | - | d/i | 支持打印number、bool和bigint类型。 | 123 | - | s | 支持打印string、undefined和null类型。 | "123" | + | d/i | 支持打印number、bool类型。 | 123 | + | s | 支持打印char*类型。 | "hello" | - 格式字符串中可以设置多个参数，例如格式字符串为“%{public}s World”，“%{public}s”为参数类型为string的变参标识，具体取值在args中定义。 + 格式字符串中可以设置多个参数，例如格式字符串为“%{public}s World”，“%{public}s”为参数类型为字符串的变参标识，具体取值在args中定义。 调试时可通过命令“hilog -p off”指令，关闭隐私开关，明文显示private日志内容。 diff --git a/zh-cn/application-dev/dfx/hilog.md b/zh-cn/application-dev/dfx/hilog.md index 2ec320471f242e09894f7a35b18a76d176490b7f..a0c0131d6c218cc7af3443df854f5bc55c0028ef 100644 --- a/zh-cn/application-dev/dfx/hilog.md +++ b/zh-cn/application-dev/dfx/hilog.md @@ -32,12 +32,12 @@ HiLog日志系统，提供给系统框架、服务、以及应用，用于打印 ### hilog日志格式说明 ```text -日期 时间 进程号 线程号 日志级别 domainID/日志tag: 日志内容 +日期 时间 进程号 线程号 日志级别 domainID/日志tag: 日志内容 04-19 17:02:14.735 5394 5394 I A03200/testTag: this is a info level hilog ``` -如上，这是一条domainID为0x3200、tag是"testTag"的INFO级别的日志： +如上，这是一条domainID为0x3200、日志tag是"testTag"的INFO级别的日志： > **说明：** > @@ -49,52 +49,28 @@ HiLog日志系统，提供给系统框架、服务、以及应用，用于打印 ## 命令行说明 + | 短选项 | 长选项 | 参数 | 说明 | | -------- | -------- | -------- | -------- | | -h | --help | - | 帮助命令。 | | 缺省 | 缺省 | - | 阻塞读日志，不退出。 | | -x | --exit | - | 非阻塞读日志，读完退出。 | -| -g | - | - | 查询buffer的大小，配合-t指定某一类型使用，默认app和core。 | -| -G | --buffer-size | <size> | 设置指定<type>日志类型缓冲区的大小，配合-t指定某一类型使用，默认app和core， 可使用B/K/M为单位，范围为64K-16M。 | -| -r | - | - | 清除buffer日志，配合-t指定某一类型使用，默认app和core。 | -| -p | --privacy | <on/off> | 支持系统调试时日志隐私开关控制。 | -| | | on | 打开隐私开关，显示<private>。 | -| | | off | 关闭隐私开关，显示明文。 | -| -k | - | <on/off> | Kernel日志读取开关控制。 | -| | | on | 打开读取kernel日志。 | -| | | off | 关闭读取kernel日志。 | -| -s | --statistics | - | 查询统计信息，需配合-t或-D使用。 | -| -S | - | - | 清除统计信息，需配合-t或-D使用。 | -| -Q | - | <control-type> | 超限缺省配额开关控制。 | -| | | pidon | 打开进程超限管控开关。 | -| | | pidoff | 关闭进程超限管控开关。 | -| | | domainon | 打开domain超限管控开关。 | -| | | domainoff | 关闭domain超限管控开关。 | +| -a | --head | <n> | 只显示前<n>行日志。 | +| -z | --tail | <n> | 只显示后<n>行日志。 | +| -t | --type | <type> | 查看指定类型的日志。| +| | | app | 查看应用日志。 | +| | | core | 查看系统日志。 | +| | | init | 查看启动日志。 | +| | | kmsg | 查看内核日志。 | +| | | only_prerelease | 查看仅在系统release版本前打印的日志，应用开发者无需关注。 | | -L | --level | <level> | 指定级别的日志，示例：-L D/I/W/E/F。 | -| -t | --type | <type> | 指定类型的日志，示例：-t app/core/init/only_prerelease。app为应用日志，core为系统日志，init为启动日志，only_prerelease为仅在系统release版本前打印的日志，应用开发者无需关注。| | -D | --domain | <domain> | 指定domain。 | | -T | --tag | <tag> | 指定tag。 | -| -a | --head | <n> | 只显示前<n>行日志。 | -| -z | --tail | <n> | 只显示后<n>行日志。 | | -P | --pid | <pid> | 标识不同的pid。 | -| -e | --regex | <expr> | 只打印日志消息与<expr>匹配的行，其中<expr>是一个正则表达式。 | -| -f | --filename | <filename> | 设置落盘的文件名。 | -| -l | --length | <length> | 设置落盘的文件大小，需要大于等于64K。 | -| -n | --number | <number> | 设置落盘文件的个数。 | -| -j | --jobid | <jobid> | 设置落盘任务的ID。 | -| -w | --write | <control> | 落盘任务控制。 | -| | | query | 落盘任务查询。 | -| | | start | 落盘任务开始，命令行参数为文件名、单文件大小、落盘算法、rotate文件数目。 | -| | | stop | 落盘任务停止。 | -| | | refresh | 刷新缓冲区的日志到落盘文件。 | -| | | clear | 删除已经落盘的日志文件。 | -| -m | --stream | <algorithm> | 落盘方式控制。 | -| | | none | 无压缩方式落盘。 | -| | | zlib | zlib压缩算法落盘，落盘文件为.gz。 | -| | | zstd | zstd压缩算法落盘，落盘文件为.zst。 | +| -e | --regex | <expr> | 只打印日志消息与<expr>匹配的行，其中<expr>是一个正则表达式。 | | -v | --format | <format> | 显示格式控制。 | | | | time | 显示本地时间。 | -| | | color | 显示不同级别显示不同颜色，参数缺省级别颜色模式处理（按黑白方式）。 | +| | | color/colour | 不同级别显示不同颜色，缺省时按照黑白颜色模式处理。 | | | | epoch | 显示相对1970时间。 | | | | monotonic | 显示相对启动时间。 | | | | usec | 显示微秒精度时间。 | @@ -102,8 +78,38 @@ HiLog日志系统，提供给系统框架、服务、以及应用，用于打印 | | | year | 显示将年份添加到显示的时间。 | | | | zone | 显示将本地时区添加到显示的时间。 | | | | wrap | 日志换行显示时，新行不增加时间戳等前缀。 | -| -b | --baselevel | <loglevel> | 设置可打印日志的最低等级：D(DEBUG)/I(INFO)/W(WARN)/E(ERROR)/F(FATAL)。 | +| -r | - | - | 清除buffer日志，配合-t指定某一类型使用，默认app和core。 | +| -g | - | - | 查询buffer的大小，配合-t指定某一类型使用，默认app和core。 | +| -G | --buffer-size | <size> | 设置指定<type>日志类型缓冲区的大小，配合-t指定某一类型使用，默认app和core， 可使用B/K/M为单位，范围为64K-16M。 | +| -s | --statistics | - | 查询统计信息，需配合-t或-D使用。 | +| -S | - | - | 清除统计信息，需配合-t或-D使用。 | +| -w | --write | <control> | 落盘任务控制。 | +| | | query | 落盘任务查询。 | +| | | start | 落盘任务开始，命令行参数为文件名、单文件大小、落盘算法、rotate文件数目。 | +| | | stop | 落盘任务停止。 | +| | | refresh | 刷新缓冲区的日志到落盘文件。 | +| | | clear | 删除已经落盘的日志文件。 | +| -f | --filename | <filename> | 设置落盘的文件名。 | +| -l | --length | <length> | 设置落盘的文件大小，需要大于等于64K。 | +| -n | --number | <number> | 设置落盘文件的个数。 | +| -m | --stream | <algorithm> | 落盘方式控制。 | +| | | none | 无压缩方式落盘。 | +| | | zlib | zlib压缩算法落盘，落盘文件为.gz。 | +| -j | --jobid | <jobid> | 设置落盘任务的ID。 | +| -p | --privacy | <on/off> | 支持系统调试时日志隐私开关控制。 | +| | | on | 打开隐私开关，显示<private>。 | +| | | off | 关闭隐私开关，显示明文。 | +| -k | - | <on/off> | Kernel日志读取开关控制。 | +| | | on | 打开读取kernel日志。 | +| | | off | 关闭读取kernel日志。 | +| -Q | - | <control-type> | 超限缺省配额开关控制。 | +| | | pidon | 打开进程超限管控开关。 | +| | | pidoff | 关闭进程超限管控开关。 | +| | | domainon | 打开domain超限管控开关。 | +| | | domainoff | 关闭domain超限管控开关。 | +| -b | --baselevel | <loglevel> | 设置可打印日志的最低等级：D(DEBUG)/I(INFO)/W(WARN)/E(ERROR)/F(FATAL)。可以和-D、-T结合使用，设置指定日志可打印的最低等级。 | | | --persist| - |配置日志级别设置命令持久化（重启设置不会丢失）。| + ## 常见使用场景