日志管理

2021-02-02

PSDK 日志管理相关功能的头文件为psdk_logger.h,本文档描述了psdk_logger.h 文件中结构体和函数原型的关键信息和使用方法。

目录

宏定义、枚举与结构体

typedef function ConsoleFunc

功能:日志输出方式 product:all

注册日志输出方式

说明: 在注册日志输出方式前,请先测试该日志输出方式能够正常打印用户所需的日志。

typedef T_PsdkReturnCode (*ConsoleFunc)(const uint8_t *data, uint16_t dataLen);

typedef enum E_PsdkLoggerConsoleLogLevel

日志类型

typedef enum {
PSDK_LOGGER_CONSOLE_LOG_LEVEL_ERROR = 1, 打印系统错误类型(Error)的日志
PSDK_LOGGER_CONSOLE_LOG_LEVEL_WARNING = 2, 打印警告信息类型(Warning)的日志
PSDK_LOGGER_CONSOLE_LOG_LEVEL_INFO = 3, 打印关键信息类型(Info)的日志
PSDK_LOGGER_CONSOLE_LOG_LEVEL_DEBUG = 4, 打印调试信息类型(Debug)的日志
} E_PsdkLoggerConsoleLogLevel;

typedef struct E_PsdkLoggerConsoleLogLevel

日志等级

typedef struct {
uint8_t consoleLevel; 指定所需打印的日志等级,日志的等级从高到低为Debug、Info、Warn和Error,
日志管理功能模块可打印不高于指定等级的所有日志
ConsoleFunc func; 指定日志输出方式,在注册日志输出方式前,请先测试该日志输出方式能够正常打印用户所需的日志
} T_PsdkLoggerConsole;

函数原型

function PsdkLogger_AddConsole

功能:注册日志输出方式 product:all

注册日志输出方式。

说明: 在注册日志输出方式前,请先测试该日志输出方式能够正常打印用户所需的日志。

T_PsdkReturnCode PsdkLogger_AddConsole(T_PsdkLoggerConsole *console);

参数
console:指向日志输出的方式
返回值
根据程序执行的情况输出对应的返回值,详情请参见:PsdkErrorCode

function PsdkLogger_UserLogInfo

功能:输出info 类型的用户日志 product:all

以指定的输出方式输出负载设备中info 类型的用户日志。

void PsdkLogger_UserLogInfo(const char *fmt, ...);

参数
fmt:指向用户需打印的日志内容
...:可变参数,与printf 中的可变参数用法一致
返回值
根据程序执行的情况输出对应的返回值,详情请参见:PsdkErrorCode

function PsdkLogger_UserLogWarn

功能:输出warn 类型的用户日志 product:all

以指定的输出方式输出负载设备中warning 类型的用户日志。

void PsdkLogger_UserLogWarn(const char *fmt, ...);

参数
fmt:指向用户需打印的日志内容
...:可变参数,与printf 中的可变参数用法一致
返回值
根据程序执行的情况输出对应的返回值,详情请参见:PsdkErrorCode

function PsdkLogger_UserLogDebug

功能:输出debug 类型的用户日志 product:all

以指定的输出方式输出负载设备中debug 类型的用户日志。

void PsdkLogger_UserLogDebug(const char *fmt, ...);

参数
fmt:指向用户需打印的日志内容
...:可变参数,与printf 中的可变参数用法一致
返回值
根据程序执行的情况输出对应的返回值,详情请参见:PsdkErrorCode

function PsdkLogger_UserLogError

功能:输出error 类型的用户日志 product:all

以指定的输出方式输出负载设备中error 类型的用户日志。

void PsdkLogger_UserLogError(const char *fmt, ...);

参数
fmt:指向用户需打印的日志内容
...:可变参数,与printf 中的可变参数用法一致
返回值
根据程序执行的情况输出对应的返回值,详情请参见:PsdkErrorCode