diff --git a/en/application-dev/reference/native-apis/log_8h.md b/en/application-dev/reference/native-apis/log_8h.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..ed2777d472663cc2090147091f05e1a1d3df28ad 100644 --- a/en/application-dev/reference/native-apis/log_8h.md +++ b/en/application-dev/reference/native-apis/log_8h.md @@ -0,0 +1,73 @@ +# log.h + + +## Overview + +Defines the logging functions of the HiLog module. + +Before 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. + +Service domain: service domain of logs. You can define the value as required. Its value is a hexadecimal integer ranging from 0x0 to 0xFFFF. + +Log tag: a string used to identify the class, file, or service behavior. + +Log level: DEBUG, INFO, WARN, ERROR, or FATAL + +Parameter format: printf format string, which starts with a % character, including a parameter type identifier and a variable parameter. + +Privacy 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**. + +Sample code: + +Defining the service domain and log tag: + +\#define LOG_DOMAIN 0x0201 + +\#define LOG_TAG "MY_TAG" + +Outputting logs: + +HILOG_WARN([LOG_APP](_hi_log.md), "Failed to visit %{private}s, reason:%{public}d.", url, errno); + +Output: + +05-06 15:01:06.870 1051 1051 W 0201/MY_TAG: Failed to visit <private>, reason:503. + +**Since:** +8 + +**Related Modules:** + +[HiLog](_hi_log.md) + + +## Summary + + +### Macros + +| Name | Description | +| -------- | -------- | +| [LOG_DOMAIN](_hi_log.md#log_domain) 0 | Defines the service domain for a log file. | +| [LOG_TAG](_hi_log.md#log_tag) NULL | Defines a string constant used to identify the class, file, or service. | +| [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. | +| [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. | +| [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. | +| [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. | +| [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. | + + +### Enums + +| Name | Description | +| -------- | -------- | +| [LogType](_hi_log.md#logtype) { LOG_APP = 0 } | Enumerates log types. | +| [LogLevel](_hi_log.md#loglevel) {
LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6,
LOG_FATAL = 7
} | Enumerates log levels. | + + +### Functions + +| Name | Description | +| -------- | -------- | +| [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. | +| [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. |