log.h


log.h

Overview

Related Modules:

HiLog

Description:

HiLog模块日志接口定义,通过这些接口实现日志打印相关功能。

用户输出日志时,先定义日志所属业务领域、日志TAG,然后按照类型、级别选择对应API,指定参数隐私标识输出日志内容。 业务领域:指定日志所对应的业务领域,用户自定义使用,用于标识业务的子系统、模块。16进制整数,范围0x0~0xFFFF。 日志TAG:字符串常量,用于标识调用所在的类或者业务。 日志级别:DEBUG、INFO、WARN、ERROR、FATAL。 参数格式:类printf的方式,包括格式字符串(包括参数类型标识)和变参。 隐私参数标识:在格式字符串每个参数中符号后类型前增加{public}、{private}标识。注意:每个参数未指定隐私标识时,缺省为隐私。 使用示例: 定义业务领域、TAG: #define LOG_DOMAIN 0x0201 #define LOG_TAG "MY_TAG" 日志打印: HILOG_WARN(LOG_APP, "Failed to visit %{private}s, reason:%{public}d.", url, errno); 结果输出: 05-06 15:01:06.870 1051 1051 W 0201/MY_TAG: Failed to visit <private>, reason:503.

Since: 8

Summary

Macros

Macro Name and Value Description
LOG_DOMAIN   0 日志所对应的业务领域,用于标识业务的子系统、模块。
LOG_TAG   NULL 字符串常量,标识调用所在的类或者业务。
OH_LOG_DEBUG(type, ...)   ((void)OH_LOG_Print((type), LOG_DEBUGLOG_DOMAINLOG_TAGVA_ARGS)) DEBUG级别写日志,宏封装接口。
OH_LOG_INFO(type, ...)   ((void)OH_LOG_Print((type), LOG_INFOLOG_DOMAINLOG_TAGVA_ARGS)) INFO级别写日志,宏封装接口。
OH_LOG_WARN(type, ...)   ((void)OH_LOG_Print((type), LOG_WARNLOG_DOMAINLOG_TAGVA_ARGS)) WARN级别写日志,宏封装接口。
OH_LOG_ERROR(type, ...)   ((void)OH_LOG_Print((type), LOG_ERRORLOG_DOMAINLOG_TAGVA_ARGS)) ERROR级别写日志,宏封装接口。
OH_LOG_FATAL(type, ...)   ((void)HiLogPrint((type), LOG_FATALLOG_DOMAINLOG_TAGVA_ARGS)) FATAL级别写日志,宏封装接口。

Enumerations

Enumeration Name Description
LogType { LOG_APP = 0 } 日志类型。
LogLevel {   LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6,   LOG_FATAL = 7 } 日志级别。

Functions

Function Description
OH_LOG_Print (LogType type, LogLevel level, unsigned int domain, const char *tag, const char *fmt,...) attribute((format(os_log int
写日志接口。
OH_LOG_IsLoggable (unsigned int domain, const char *tag, LogLevel level) int bool
检查指定业务领域、TAG、级别的日志是否可以打印。