Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
758ad31b
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
758ad31b
编写于
5月 24, 2022
作者:
Z
zengyawen
提交者:
Gitee
5月 24, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/application-dev/reference/apis/js-apis-hilog.md.
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
730b513f
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
111 addition
and
92 deletion
+111
-92
zh-cn/application-dev/reference/apis/js-apis-hilog.md
zh-cn/application-dev/reference/apis/js-apis-hilog.md
+111
-92
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-hilog.md
浏览文件 @
758ad31b
# 日志打印
hilog日志系统,使应用/服务可以按照指定级别、标识和格式字符串输出日志内容,帮助开发者了解应用/服务的运行状态,更好地调试程序。
以下文档仅对接口功能进行描述,具体的日志打印要求请参考
[
OpenHarmony日志打印规范
](
../../../contribute/OpenHarmony-Log-guide.md
)
。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
hilog
from
'
@ohos.hilog
'
;
```
## hilog.isLoggable
## hilog.debug
debug(domain: number, tag: string, format: string, ...args: any[]) : void
isLoggable(domain: number, tag: string, level: LogLevel) : boolean
debug日志输出,打印debug级别日志
。
在打印日志前调用该接口,用于检查指定领域标识、日志标识和级别的日志是否可以打印
。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number | 是 | 业务领域。范围0x0~0xFFFFF。 |
| tag | string | 是 | 字符串常量,标识调用所在的类或者业务行为。 |
| format | string | 是 | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args | any[] | 是 | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------- | ---- | ------------------------------------------------------------ |
| domain | number | 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。 |
| tag | string | 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。 |
| level |
[
LogLevel
](
#loglevel
)
| 是 | 日志级别。 |
**返回值:**
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 如果返回true,则该领域标识、日志标识和级别的日志可以打印,否则不能打印。 |
**示例:**
```
hilog.
debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0
);
```
js
hilog
.
isLoggable
(
0x0001
,
"
testTag
"
,
hilog
.
LogLevel
.
INFO
);
```
**输出:**
## LogLevel
```
09-08 12:49:35.941 1547 2452 D FF00/testTag: 1: hello World 3.0
```
日志级别。
## hilog.info
**系统能力:**
SystemCapability.HiviewDFX.HiLog
info(domain: number, tag: string, format: string, ...args: any[]) : void
| 名称 | 默认值 | 说明 |
| ----- | ------ | ------------------------------------------------------------ |
| DEBUG | 3 | 详细的流程记录,通过该级别的日志可以更详细地分析业务流程和定位分析问题。 |
| INFO | 4 | 用于记录业务关键流程节点,可以还原业务的主要运行过程;
<br/>
用于记录可预料的非正常情况信息,如无网络信号、登录失败等。
<br/>
这些日志都应该由该业务内处于支配地位的模块来记录,避免在多个被调用的模块或低级函数中重复记录。 |
| WARN | 5 | 用于记录较为严重的非预期情况,但是对用户影响不大,应用可以自动恢复或通过简单的操作就可以恢复的问题。 |
| ERROR | 6 | 应用发生了错误,该错误会影响功能的正常运行或用户的正常使用,可以恢复但恢复代价较高,如重置数据等。 |
| FATAL | 7 | 重大致命异常,表明应用即将崩溃,故障无法恢复。 |
## hilog.debug
debug(domain: number, tag: string, format: string, ...args: any[]) : void
info日志输出,打印info级别日志。
打印DEBUG级别的日志。
DEBUG级别的日志在正式发布版本中默认不被打印,只有在调试版本或打开调试开关的情况下才会打印。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型
| 必填 | 说明 |
| ------ | ------
--------
| ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 业务领域。范围0x0~0xFFFFF。
|
| tag | string
| 是 | 字符串常量,标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数
。 |
| args | any[] | 是 | 与格式字符串
里参数类型
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。
|
| tag | string
| 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,用于日志的格式化输出。格式字符串中可以设置多个参数,参数需要包含参数类型、隐私标识。
<br>
隐私标识分为{public}和{private},缺省为{private}。标识{public}的内容明文输出,标识{private}的内容以
\<
private>过滤回显
。 |
| args | any[] | 是 | 与格式字符串
format
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
**示例:**
```
hilog.info(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
输出一条DEBUG信息,格式字符串为
`"%{public}s World %{private}d"`
。其中变参
`%{public}s`
为明文显示的字符串;
`%{private}d`
为隐私的整型数。
```
js
hilog
.
debug
(
0x0001
,
"
testTag
"
,
"
%{public}s World %{private}d
"
,
"
hello
"
,
3
);
```
**输出:**
字符串
`"hello"`
填入
`%{public}s`
,整型数
`3`
填入
`%{private}d`
,输出日志:
```
0
9-08 12:49:35.941 1547 2452 I FF00/testTag: 1: hello World 3.0
0
8-05 12:21:47.579 2695-2703/com.example.myapplication D 00001/testTag: hello World <private>
```
## hilog.
warn
## hilog.
info
warn
(domain: number, tag: string, format: string, ...args: any[]) : void
info
(domain: number, tag: string, format: string, ...args: any[]) : void
warn日志输出,打印warn级别
日志。
打印INFO级别的
日志。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型
| 必填 | 说明 |
| ------ | ------
--------
| ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 业务领域。范围0x0~0xFFFFF。
|
| tag | string
| 是 | 字符串常量,标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数
。 |
| args | any[] | 是 | 与格式字符串
里参数类型
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。
|
| tag | string
| 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,用于日志的格式化输出。格式字符串中可以设置多个参数,参数需要包含参数类型、隐私标识。
<br/>
隐私标识分为{public}和{private},缺省为{private}。标识{public}的内容明文输出,标识{private}的内容以
\<
private>过滤回显
。 |
| args | any[] | 是 | 与格式字符串
format
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
**示例:**
```
hilog.warn(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
输出一条INFO信息,格式字符串为
`"%{public}s World %{private}d"`
。其中变参
`%{public}s`
为明文显示的字符串;
`%{private}d`
为隐私的整型数。
```
js
hilog
.
info
(
0x0001
,
"
testTag
"
,
"
%{public}s World %{private}d
"
,
"
hello
"
,
3
);
```
**输出:**
字符串
`"hello"`
填入
`%{public}s`
,整型数
`3`
填入
`%{private}d`
,输出日志:
```
0
9-08 12:49:35.941 1547 2452 W FF00/testTag: 1: hello World 3.0
0
8-05 12:21:47.579 2695-2703/com.example.myapplication I 00001/testTag: hello World <private>
```
## hilog.
error
## hilog.
warn
error
(domain: number, tag: string, format: string, ...args: any[]) : void
warn
(domain: number, tag: string, format: string, ...args: any[]) : void
error日志输出,打印error级别
日志。
打印WARN级别的
日志。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型
| 必填 | 说明 |
| ------ | ------
--------
| ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 业务领域。范围0x0~0xFFFFF。
|
| tag | string
| 是 | 字符串常量,标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数
。 |
| args | any[] | 是 | 与格式字符串
里参数类型
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。
|
| tag | string
| 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,用于日志的格式化输出。格式字符串中可以设置多个参数,参数需要包含参数类型、隐私标识。
<br/>
隐私标识分为{public}和{private},缺省为{private}。标识{public}的内容明文输出,标识{private}的内容以
\<
private>过滤回显
。 |
| args | any[] | 是 | 与格式字符串
format
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
**示例:**
```
hilog.error(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
输出一条WARN信息,格式字符串为
`"%{public}s World %{private}d"`
。其中变参
`%{public}s`
为明文显示的字符串;
`%{private}d`
为隐私的整型数。
```
js
hilog
.
warn
(
0x0001
,
"
testTag
"
,
"
%{public}s World %{private}d
"
,
"
hello
"
,
3
);
```
**输出:**
字符串
`"hello"`
填入
`%{public}s`
,整型数
`3`
填入
`%{private}d`
,输出日志:
```
0
9-08 12:49:35.941 1547 2452 E FF00/testTag: 1: hello World 3.0
0
8-05 12:21:47.579 2695-2703/com.example.myapplication W 00001/testTag: hello World <private>
```
## hilog.
fatal
## hilog.
error
fatal
(domain: number, tag: string, format: string, ...args: any[]) : void
error
(domain: number, tag: string, format: string, ...args: any[]) : void
fatal日志输出,打印fatal级别
日志。
打印ERROR级别的
日志。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型
| 必填 | 说明 |
| ------ | ------
--------
| ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 业务领域。范围0x0~0xFFFFF。
|
| tag | string
| 是 | 字符串常量,标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数
。 |
| args | any[] | 是 | 与格式字符串
里参数类型
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| domain | number
| 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。
|
| tag | string
| 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。
|
| format | string
| 是 | 格式字符串,用于日志的格式化输出。格式字符串中可以设置多个参数,参数需要包含参数类型、隐私标识。
<br/>
隐私标识分为{public}和{private},缺省为{private}。标识{public}的内容明文输出,标识{private}的内容以
\<
private>过滤回显
。 |
| args | any[] | 是 | 与格式字符串
format
对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
**示例:**
```
hilog.fatal(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
输出一条ERROR信息,格式字符串为
`"%{public}s World %{private}d"`
。其中变参
`%{public}s`
为明文显示的字符串;
`%{private}d`
为隐私的整型数。
```
js
hilog
.
error
(
0x0001
,
"
testTag
"
,
"
%{public}s World %{private}d
"
,
"
hello
"
,
3
);
```
**输出:**
字符串
`"hello"`
填入
`%{public}s`
,整型数
`3`
填入
`%{private}d`
,输出日志:
```
0
9-08 12:49:35.941 1547 2452 F FF00/testTag: 1: hello World 3.0
0
8-05 12:21:47.579 2695-2703/com.example.myapplication E 00001/testTag: hello World <private>
```
## hilog.
isLoggable
## hilog.
fatal
isLoggable(domain: number, tag: string, level: LogLevel) : boolean
fatal(domain: number, tag: string, format: string, ...args: any[]) : void
检查一个domain、tag和日志级别是否被禁止打印
日志。
打印FATAL级别的
日志。
**系统能力:**
SystemCapability.HiviewDFX.HiLog
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------- | ---- | ------------------------------------------ |
| domain | number | 是 | 业务领域。范围0x0~0xFFFFF。 |
| tag | string | 是 | 字符串常量,标识调用所在的类或者业务行为。 |
| level |
[
LogLevel
](
#loglevel
)
| 是 | 日志级别。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| domain | number | 是 | 日志对应的领域标识,范围是0x0~0xFFFF,开发者可根据需要自定义。 |
| tag | string | 是 | 指定日志标识,可以为任意字符串,建议用于标识调用所在的类或者业务行为。 |
| format | string | 是 | 格式字符串,用于日志的格式化输出。格式字符串中可以设置多个参数,参数需要包含参数类型、隐私标识。
<br/>
隐私标识分为{public}和{private},缺省为{private}。标识{public}的内容明文输出,标识{private}的内容以
\<
private>过滤回显。 |
| args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
**示例:**
```
hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG);
```
## LogLevel
输出一条FATAL信息,格式字符串为
`"%{public}s World %{private}d"`
。其中变参
`%{public}s`
为明文显示的字符串;
`%{private}d`
为隐私的整型数。
用于表示事件类型。
```
js
hilog
.
fatal
(
0x0001
,
"
testTag
"
,
"
%{public}s World %{private}d
"
,
"
hello
"
,
3
);
```
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiLog。
字符串
`"hello"`
填入
`%{public}s`
,整型数
`3`
填入
`%{private}d`
,输出日志:
| 名称 | 默认值 | 说明 |
| ----- | ------ | ----------- |
| DEBUG | 3 | DEBUG级别。 |
| INFO | 4 | INFO级别。 |
| WARN | 5 | WARN级别。 |
| ERROR | 6 | ERROR级别。 |
| FATAL | 7 | FATAL级别。 |
\ No newline at end of file
```
08-05 12:21:47.579 2695-2703/com.example.myapplication F 00001/testTag: hello World <private>
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录