js-apis-hilog.md 6.4 KB
Newer Older
S
shawn_he 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
# HiLog

> **Note:**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

## Modules to Import

```
import hilog from '@ohos.hilog';
```

## System Capabilities

SystemCapability.HiviewDFX.HiLog

## hilog.debug

debug(domain: number, tag: string, format: string, ...args: any[]) : void

Prints logs of the DEBUG level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string         | Yes| String constant used to identify the class or service behavior.|
| format | string         | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.|
| args   | any[]          | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.|

**Example**

```
hilog.debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**Output**

```
09-08 12:49:35.941  1547  2452 D FF00/testTag: 1: hello World 3.0
```

## **hilog.info**

info(domain: number, tag: string, format: string, ...args: any[]) : void

Prints logs of the INFO level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string         | Yes| String constant used to identify the class or service behavior.|
| format | string         | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.|
| args   | any[]  | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.|

**Example**

```
hilog.info(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**Output**

```
09-08 12:49:35.941  1547  2452 I FF00/testTag: 1: hello World 3.0
```

## hilog.warn

warn(domain: number, tag: string, format: string, ...args: any[]) : void

Prints logs of the WARN level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string         | Yes| String constant used to identify the class or service behavior.|
| format | string         | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.|
| args   | any[]  | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.|

**Example**

```
hilog.warn(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**Output**

```
09-08 12:49:35.941  1547  2452 W FF00/testTag: 1: hello World 3.0
```

## hilog.error

error(domain: number, tag: string, format: string, ...args: any[]) : void

Prints logs of the ERROR level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string         | Yes| String constant used to identify the class or service behavior.|
| format | string         | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.|
| args   | any[]  | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.|

**Example**

```
hilog.error(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**Output**

```
09-08 12:49:35.941  1547  2452 E FF00/testTag: 1: hello World 3.0
```

## hilog.fatal

fatal(domain: number, tag: string, format: string, ...args: any[]) : void

Prints logs of the FATAL level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string         | Yes| String constant used to identify the class or service behavior.|
| format | string         | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.|
| args   | any[]  | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.|

**Example**

```
hilog.fatal(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**Output**

```
09-08 12:49:35.941  1547  2452 F FF00/testTag: 1: hello World 3.0
```

## hilog.isLoggable

isLoggable(domain: number, tag: string, level: LogLevel) : boolean

Checks whether printing is enabled for a domain, tag, or log level.

**Parameters**

| Name| Type| Mandatory| Description|
| ------ | --------------------- | ---- | ------------------------------------------ |
| domain | number                | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.|
| tag    | string                | Yes| String constant used to identify the class or service behavior.|
| level  | [LogLevel](#loglevel) | Yes| Log level.|

**Example**

```
hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG);
```

## LogLevel

Enumerates event types.

| Name| Default Value| Description|
| ----- | ------ | ----------- |
| DEBUG | 3      | DEBUG level|
| INFO  | 4      | INFO level|
| WARN  | 5      | WARN level|
| ERROR | 6      | ERROR level|
| FATAL | 7      | FATAL level|