Google neper学习(1)-日志logging

一、日志介绍

neper中在logging.h和logging.c为neper志定义,功能为记录xx,并保存到本地.log文件
日志共有四个等级,和两个常用函数

enum LOG_LEVEL { FATAL, ERROR, WARNING, INFO };
  1. LOG_INFO
    在程序状态或其他重要事件发生时,记录到日至以便调试
  2. LOG_WARN
    可能导致问题出现的意外事件一旦发生,便记录下来。例如服务端收到错误报文。
  3. LOG_ERROR
    用于报告程序可以从中恢复的错误信息。所有错误都要被报告。
  4. LOG_FATAL
    用于报告程序无法从中恢复的错误信息。用于你想要程序退出的地方。
  5. callbacks->print
    在终端打印键-值信息,不是线程安全的
  6. 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); // 退出
        }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352