1# log.h 2 3 4## Overview 5 6Defines the logging functions of the HiLog module. 7 8Before outputting logs, you must define the service domain, and log tag, use the function with the specified log type and level, and specify the privacy identifier. 9 10Service domain: service domain of logs. You can define the value as required. Its value is a hexadecimal integer ranging from 0x0 to 0xFFFF. 11 12Log tag: a string used to identify the class, file, or service behavior. 13 14Log level: DEBUG, INFO, WARN, ERROR, or FATAL 15 16Parameter format: printf format string, which starts with a % character, including a parameter type identifier and a variable parameter. 17 18Privacy identifier: **{public}** or **{private}** added between the % character and the parameter type identifier in each parameter. If no privacy identifier is added, the parameter is considered to be **private**. 19 20Sample code: 21 22Defining the service domain and log tag: 23 24\#define LOG_DOMAIN 0x0201 25 26\#define LOG_TAG "MY_TAG" 27 28Outputting logs: 29 30HILOG_WARN([LOG_APP](_hi_log.md), "Failed to visit %{private}s, reason:%{public}d.", url, errno); 31 32Output: 33 3405-06 15:01:06.870 1051 1051 W 0201/MY_TAG: Failed to visit <private>, reason:503. 35 36**Since:** 378 38 39**Related Modules:** 40 41[HiLog](_hi_log.md) 42 43 44## Summary 45 46 47### Macros 48 49| Name | Description | 50| -------- | -------- | 51| [LOG_DOMAIN](_hi_log.md#log_domain) 0 | Defines the service domain for a log file. | 52| [LOG_TAG](_hi_log.md#log_tag) NULL | Defines a string constant used to identify the class, file, or service. | 53| [OH_LOG_DEBUG](_hi_log.md#oh_log_debug)(type, ...) ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), [LOG_DEBUG](_hi_log.md), [LOG_DOMAIN](_hi_log.md#log_domain), [LOG_TAG](_hi_log.md#log_tag), \_\_VA_ARGS__)) | Outputs DEBUG logs. This is a function-like macro. | 54| [OH_LOG_INFO](_hi_log.md#oh_log_info)(type, ...) ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), [LOG_INFO](_hi_log.md), [LOG_DOMAIN](_hi_log.md#log_domain), [LOG_TAG](_hi_log.md#log_tag), \_\_VA_ARGS__)) | Outputs INFO logs. This is a function-like macro. | 55| [OH_LOG_WARN](_hi_log.md#oh_log_warn)(type, ...) ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), [LOG_WARN](_hi_log.md), [LOG_DOMAIN](_hi_log.md#log_domain), [LOG_TAG](_hi_log.md#log_tag), \_\_VA_ARGS__)) | Outputs WARN logs. This is a function-like macro. | 56| [OH_LOG_ERROR](_hi_log.md#oh_log_error)(type, ...) ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), [LOG_ERROR](_hi_log.md), [LOG_DOMAIN](_hi_log.md#log_domain), [LOG_TAG](_hi_log.md#log_tag), \_\_VA_ARGS__)) | Outputs ERROR logs. This is a function-like macro. | 57| [OH_LOG_FATAL](_hi_log.md#oh_log_fatal)(type, ...) ((void)HiLogPrint((type), [LOG_FATAL](_hi_log.md), [LOG_DOMAIN](_hi_log.md#log_domain), [LOG_TAG](_hi_log.md#log_tag), \_\_VA_ARGS__)) | Outputs FATAL logs. This is a function-like macro. | 58 59 60### Enums 61 62| Name | Description | 63| -------- | -------- | 64| [LogType](_hi_log.md#logtype) { LOG_APP = 0 } | Enumerates log types. | 65| [LogLevel](_hi_log.md#loglevel) {<br/>LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6,<br/>LOG_FATAL = 7<br/>} | Enumerates log levels. | 66 67 68### Functions 69 70| Name | Description | 71| -------- | -------- | 72| [OH_LOG_Print](_hi_log.md#oh_log_print) ([LogType](_hi_log.md#logtype) type, [LogLevel](_hi_log.md#loglevel) level, unsigned int domain, const char \*tag, const char \*fmt,...) \_\_attribute__((\_\_format__(os_log, 5, 6))) |Outputs logs. | 73| [OH_LOG_IsLoggable](_hi_log.md#oh_log_isloggable) (unsigned int domain, const char \*tag, [LogLevel](_hi_log.md#loglevel) level) | Checks whether logs of the specified service domain, log tag, and log level can be output. | 74