一、日志介绍
neper中在logging.h和logging.c为neper志定义,功能为记录xx,并保存到本地.log文件
日志共有四个等级,和两个常用函数
enum LOG_LEVEL { FATAL, ERROR, WARNING, INFO };
-
LOG_INFO
在程序状态或其他重要事件发生时,记录到日至以便调试 -
LOG_WARN
可能导致问题出现的意外事件一旦发生,便记录下来。例如服务端收到错误报文。 -
LOG_ERROR
用于报告程序可以从中恢复的错误信息。所有错误都要被报告。 -
LOG_FATAL
用于报告程序无法从中恢复的错误信息。用于你想要程序退出的地方。 -
callbacks->print
在终端打印键-值信息,不是线程安全的 -
logtostderr
唤醒日志线程存储标准输出流错误信息
二、日志初始化和退出:创建/打开本地.log
文件初始化cb(callbacks)
结构体
void logging_init(struct callbacks *cb)
{
open_log(); // 创建本地log文件将来写入
cb->logger = NULL;
cb->print = print; // static void print(void *logger, const char *key, const char *value_fmt, ...)
cb->log_fatal = log_fatal;
cb->log_error = log_error;
cb->log_warn = log_warn;
cb->log_info = log_info;
cb->logtostderr = logtostderr;
}
以上是callbacks
的所有参数,定义在lib.h
文件。这样做的目的是利用指针调用日志函数。open_log()
不是线程安全的,使用时需要自行加锁
void logging_exit(struct callbacks *cb)
{
close_log();
}
终止日志为调用close_log()
使用fclose()
关闭本地.log文件描述符。
三、使用日志
在其他文件中使用日志,首先初始化一个callbacks结构体,并初始化。然后使用宏定义PRINT, LOG_FATAL, LOG_ERROR, LOG_WARN, LOG_INFO, PLOG_FATAL, PLOG_ERROR, CHECK
来进行打印和存储日志。
这额宏定义在looging.h中:
#define PRINT(cb, key, value_fmt, args...) \
(cb)->print((cb)->logger, key, value_fmt, ##args)
#define LOG_FATAL(cb, fmt, args...) \
(cb)->log_fatal((cb)->logger, __FILE__, __LINE__, __func__, fmt, ##args)
#define LOG_ERROR(cb, fmt, args...) \
(cb)->log_error((cb)->logger, __FILE__, __LINE__, __func__, fmt, ##args)
#define LOG_WARN(cb, fmt, args...) \
(cb)->log_warn((cb)->logger, __FILE__, __LINE__, __func__, fmt, ##args)
#define LOG_INFO(cb, fmt, args...) \
(cb)->log_info((cb)->logger, __FILE__, __LINE__, __func__, fmt, ##args)
#define PLOG_FATAL(cb, fmt, args...) \
LOG_FATAL(cb, fmt ": %s", ##args, strerror(errno))
#define PLOG_ERROR(cb, fmt, args...) \
LOG_ERROR(cb, fmt ": %s", ##args, strerror(errno))
#define CHECK(cb, cond, fmt, args...) \
if (!(cond)) \
LOG_FATAL(cb, fmt, ##args)
可以看出使用宏定义时简洁调用了print, log_fatal, log_error, log_warn, log_info
等函数。并且使用了##args来编译,实际上是将fmt后的参数串起来(具体使用方法见blog)。
例log_info
:
static void log_info(void *logger, const char *file, int line,
const char *function, const char *format, ...)
{
va_list argp;
va_start(argp, format);
logging(file, line, function, INFO, format, argp);
va_end(argp);
}
函数参数包括logger(cb), file(文件名), line(行号), function(函数名)
以及日志等级,在这里为INFO
va_list可以表示未一系列参数,实际上log_info中...
可能是一串参数,也可能是空。使用va_start()和va_end()可以将format后的参数parse到argp中(实际上函数参数存储在栈中,并且相邻,则可以由format得到之后的参数);va_end()将argp释放(使用方法具体见blog)。
实际上宏定义都调用了logging()
函数,其具体作用为写入log文件。
四、logging函数
实际上使用日志时,最终都会指向logging函数的使用。其会根据LOG等级来进行判断,并将参数写入.log文件,源代码有注释。理解函数需要具备fflush,stdrr,stdout,vsnprintf,timespec,tm等c语言标准库基础
static void logging(const char *file, int line, const char *func,
enum LOG_LEVEL level, const char *fmt, va_list argp)
{
char buf[4096], *msg, level_char, *path;
int size, thread_id;
struct timespec ts; // ts tm保存时间 ts更加精准
struct tm tm;
if (!log_file)
return;
// msg = fmt+argp
size = vsnprintf(buf, sizeof(buf), fmt, argp);
if (size > sizeof(buf)) {
msg = malloc(size);
vsnprintf(msg, size, fmt, argp);
} else
msg = buf;
if (level == FATAL)
level_char = 'F';
else if (level == ERROR)
level_char = 'E';
else if (level == WARNING)
level_char = 'W';
else if (level == INFO)
level_char = 'I';
else
level_char = ' ';
clock_gettime(CLOCK_REALTIME, &ts);
localtime_r(&ts.tv_sec, &tm);
thread_id = syscall(SYS_gettid);
if (thread_id == -1)
thread_id = getpid();
path = strdup(file); // c语言字符串拷贝函数 与free成对使用
// g_logtostderr = 1 则写入stderr,否则写入lof_file
fprintf(g_logtostderr ? stderr : log_file,
"%c%02d%02d %02d:%02d:%02d.%06ld %3d %6d %s:%d] %s: %s\n",
// 以ERROR为例,格式化字符串为
// E月日 时分秒纳秒 日志函数 线程id .log文件名 命令行号 fmt+argp
level_char, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min,
tm.tm_sec, ts.tv_nsec / 1000, stdout_lines, thread_id,
basename(path), line, func, msg);
free(path);
/* TODO dump stack trace if FATAL */
if (level == FATAL || level == ERROR)
fprintf(stderr, "%s\n", msg);
if (size > sizeof(buf))
free(msg);
if (level == FATAL || level == ERROR || level == WARNING)
fflush(g_logtostderr ? stderr : log_file);
// fflush()会强迫将缓冲区内的数据写回参数参数指定的文件中.
// 如果参数stream 为NULL,fflush()会将所有打开的文件数据更新
// stderr无缓冲,直接输出在屏幕,logfile输出到文件
if (level == FATAL) {
fclose(log_file);
fflush(stdout); // force print
fflush(stderr); // force print
fcloseall();
exit(1); // 退出
}
}