【神经网络与深度学习】【C/C++】C++日志操作开源函数库之Google-glog

今天想给我的C++项目找一个开源的日志类，用于记录系统日志，结果浪费了半个下午的时间。从网上搜索相关资料，找到以下几个备选方案：

1、log4cplus　　下载地址：http://sourceforge.net/projects/log4cplus/files/log4cplus-stable/1.1.0

2、log4cxx　　下载地址：http://logging.apache.org/log4cxx/download.html　　（log4cxx 是由JAVA实现的 log4j 开源的，用C++实现的一个开源库）

3、glog　　下载地址：http://code.google.com/p/google-glog/downloads/list 或者 https://github.com/google/glog

4、log4cpp　　下载地址： http://sourceforge.net/projects/log4cpp/files

　　我初步看了一下，第1个和第4个是sourceforge网站上的开源项目，不知道是不是被屏蔽了，总之是打不开网页。浪费我半小时找代理和FQ，均找不到。看到第2个是Java注明的日志类log4j的姊妹C++版，顿时感觉应该不错，结果编译的过程让我直接疯掉了。先是下载log4cxx源代码，又说光下载这个还不够，还要下载另外两个Apache项目（apr、apr-util）代码，下完这三个还不行，在Windows下编译还需要下一个Windows X64版本的Sed，好吧，这还不算数，居然还是链接失败，网上还找不到相应的解决方案，整个过程浪费我4个小时。

　　所以今天的教训就是，人家的开源项目根本就不待见Windows平台，或者说根本不待见我这样的菜鸟。既然我是Windows平台上的一只小菜鸟，那我就老老实实用简单的东西吧。从第三方网站上下载Google glog，编译一下居然轻松通过，很好！

一、基本用法测试

　　1、从网上下载google-glog-v0.3.4-50-gde75983.zip，解压到本地，可以看到工程文件google-glog.sln，可以用Visual Studio 2008打开。

　　2、直接编译就可以得到libglog.dll、libglog.lib等文件，这里的lib文件在编译时要用，而dll文件则是运行时要用的，可以看出这里的glog采用的是“隐式”动态链接库编译方法。

　　3、将解压出来的文件夹路径：“google-glogsrcwindows”添加到Visual Studio 2008 的工程路径中，以便于引用头文件。同时将上一步编译出来的lib文件加入路径或者直接拷贝到自定义工程路径中；

　　4、使用如下代码可以测试使用：

#include <iostream>
using namespace std;

#include <glog/logging.h>
#pragma comment(lib, "libglog.lib")

int main(int argc, char **argv)
{
    google::InitGoogleLogging("KLH");
    google::SetLogDestination(google::INFO, "F://");

    char str[20] = "hello log!";    
    LOG(INFO) << "Found " << google::COUNTER <<endl;    
    LOG(INFO) << str ;                // << " cookies";    
    LOG(WARNING) << "warning test";    // 会输出一个Warning日志    
    LOG(ERROR) << "error test";        // 会输出一个Error日志 

    system("pause");
    return 0;
}

　　5、编译生成的exe文件还不能直接运行，需要将第3步编译的dll文件拷贝到相同目录中才能运行。测试的日志文件自动生成在F:/根目录中。类似于如下格式内容：

Log file created at: 2015/12/14 20:28:18
Running on machine: VICTO-PC
Log line format: [IWEF]mmdd hh:mm:ss.uuuuuu threadid file:line] msg
I1214 20:28:18.590252  9648 main2.cpp:13] Found 0
I1214 20:28:18.591253  9648 main2.cpp:14] hello log!
W1214 20:28:18.591253  9648 main2.cpp:15] warning test
E1214 20:28:18.592252  9648 main2.cpp:16] error test　

　　6、其实这里可以看出，用动态链接库编译的方式有个麻烦的地方就是编译出来的exe不能单独运行，必须拷贝dll文件放到一起才行。如何采用静态链接的方式呢？答案是要看官方doc文档的说法：在自定义工程中添加“GOOGLE_GLOG_DLL_DECL=” 和 “GLOG_NO_ABBREVIATED_SEVERITIES” 这两个宏，第二个宏主要是为了避免与windows.h冲突（下面会讲到），第一个宏才是使用静态链接库时必须的！在编译时可以编译两个版本：Release 和 Debug 以供调试时使用。

　　7、在使用过程中一定要注意编译参数 “/MT” 和 “/MD” 的区别，当然还有 “/MTd” 和 “/MDd” 的不同，可以免去复杂的链接错误、冲定义等问题，在下一篇日志中会专门讲到，如果不清楚这个问题将会是很费劲的，包括之前写过一篇libevent入门的文章说在使用时要忽略一大堆的系统函数库，我觉得也是这个原因导致的。

二、Windows平台应用

　　当我在Windows平台项目上应用这个glog时遇到了一个问题，那就是直接编译上面的代码时会出现错误：

错误    2    fatal error C1189: #error :  ERROR macro is defined. Define GLOG_NO_ABBREVIATED_SEVERITIES before including logging.h. See the document for detail.    d:cppworkspaceopensourcelibrarygoogle-glogsrcwindowsgloglog_severity.h    55

　　双击这个错误很容易定位到出错的地方：

const int GLOG_INFO = 0, GLOG_WARNING = 1, GLOG_ERROR = 2, GLOG_FATAL = 3,
  NUM_SEVERITIES = 4;
#ifndef GLOG_NO_ABBREVIATED_SEVERITIES
# ifdef ERROR
#  error ERROR macro is defined. Define GLOG_NO_ABBREVIATED_SEVERITIES before including logging.h. See the document for detail.
# endif
const int INFO = GLOG_INFO, WARNING = GLOG_WARNING,
  ERROR = GLOG_ERROR, FATAL = GLOG_FATAL;
#endif

　　其实解决这个错误倒是不难，可以看到只要是在Windows工程中预定义GLOG_NO_ABBREVIATED_SEVERITIES这个宏就可以了，但是为什么要这么做呢？找了一下，答案在官方文档中：

Notes for Windows users
Google glog defines a severity level ERROR, which is also defined in windows.h . You can make glog not define INFO, WARNING, ERROR, and FATAL by defining GLOG_NO_ABBREVIATED_SEVERITIES before including glog/logging.h . Even with this macro, you can still use the iostream like logging facilities:
  #define GLOG_NO_ABBREVIATED_SEVERITIES
  #include <windows.h>
  #include <glog/logging.h>
  // ...
  LOG(ERROR) << "This should work";
  LOG_IF(ERROR, x > y) << "This should be also OK";
However, you cannot use INFO, WARNING, ERROR, and FATAL anymore for functions defined in glog/logging.h .
  #define GLOG_NO_ABBREVIATED_SEVERITIES
  #include <windows.h>
  #include <glog/logging.h>
  // ...
  // This won't work.
  // google::FlushLogFiles(google::ERROR);

  // Use this instead.
  google::FlushLogFiles(google::GLOG_ERROR);
If you don't need ERROR defined by windows.h, there are a couple of more workarounds which sometimes don't work:
#define WIN32_LEAN_AND_MEAN or NOGDI before you #include windows.h .
#undef ERROR after you #include windows.h .
See this issue for more detail.

 　　这下就清楚了，原来是glog中原来定义的ERROR宏与windows.h中的ERROR冲突了，为了避免冲突，glog作出了改变，增加了GLOG_NO_ABBREVIATED_SEVERITIES宏定义用以区分，那么在代码中用google::GLOG_ERROR来代替原来的google::ERROR

三、自定义glog日志格式

　　要自定义glog输出格式并不难，可以直接修改logging.cc文件中的LogMessage::Init函数，直接给出修改的位置：

void LogMessage::Init(const char* file,
                      int line,
                      LogSeverity severity,
                      void (LogMessage::*send_method)()) {
... ...
  if (FLAGS_log_prefix && (line != kNoLogPrefix)) {
      /*
    stream() << LogSeverityNames[severity][0]
             << setw(2) << 1+data_->tm_time_.tm_mon
             << setw(2) << data_->tm_time_.tm_mday
             << ' '
             << setw(2) << data_->tm_time_.tm_hour  << ':'
             << setw(2) << data_->tm_time_.tm_min   << ':'
             << setw(2) << data_->tm_time_.tm_sec   << "."
             << setw(6) << usecs
             << ' '
             << setfill(' ') << setw(5)
             << static_cast<unsigned int>(GetTID()) << setfill('0')
             << ' '
             << data_->basename_ << ':' << data_->line_ << "] ";
             */
      // Change output format. By KuLiuheng.    2015.12.15
      stream()    << LogSeverityNames[severity][0]
                << ' '
                << setw(4) << 1900+data_->tm_time_.tm_year    << '-'
                << setw(2) << 1+data_->tm_time_.tm_mon    << '-'
                << setw(2) << data_->tm_time_.tm_mday
                << ' '
                << setw(2) << data_->tm_time_.tm_hour  << ':'
                << setw(2) << data_->tm_time_.tm_min   << ':'
                << setw(2) << data_->tm_time_.tm_sec   << "."
                << setw(6) << usecs
                << ' '
                << setfill(' ') << setw(5)
                << static_cast<unsigned int>(GetTID()) << setfill('0')
                << ' '
                << data_->basename_ << ':' << data_->line_ << "] ";
  }
... ...
}

 　　这样一来输出的格式就是：

Log file created at: 2015/12/15 14:31:05
Running on machine: VICTO-PC
Log line format: [IWEF] yyyy-mm-dd hh:mm:ss.uuuuuu threadid file:line] msg
I 2015-12-15 14:31:05.341013  2928 main2.cpp:14] Found 0
I 2015-12-15 14:31:05.343014  2928 main2.cpp:15] hello log!
W 2015-12-15 14:31:05.343014  2928 main2.cpp:16] warning test
E 2015-12-15 14:31:05.344014  2928 main2.cpp:17] error test

四、使用glog严重错误DUMP功能

　　使用google::InstallFailureSignalHandler(); 和 google::InstallFailureWriter(&FatalMessageDump); 可以在程序出现严重错误时将详细的错误信息打印出来，但是使用默认编译的glog将会出现找不到此函数定义的问题，类似于：

error LNK2019: 无法解析的外部符号 "__declspec(dllimport) void __cdecl google::InstallFailureWriter(void (__cdecl*)(char const *,int))" (__imp_?InstallFailureWriter@google@@YAXP6AXPBDH@Z@Z)，该符号在函数 "public: void __thiscall EnvironmentManager::Initialize(int,char * *,int)" (?Initialize@EnvironmentManager@@QAEXHPAPADH@Z) 中被引用
error LNK2019: 无法解析的外部符号 "__declspec(dllimport) void __cdecl google::InstallFailureSignalHandler(void)" (__imp_?InstallFailureSignalHandler@google@@YAXXZ)，该符号在函数 "public: void __thiscall EnvironmentManager::Initialize(int,char * *,int)" (?Initialize@EnvironmentManager@@QAEXHPAPADH@Z) 中被引用

　　这个时候只需要在默认的glog工程中，将signalhandler.cc 纳入到libglog工程中，重新编译即可。重新初始化glog的方法如下：

// Start google log system:
google::InitGoogleLogging(argv[0]);
google::SetLogDestination(google::GLOG_INFO, ".//");
google::SetStderrLogging(google::GLOG_INFO);
google::SetLogFilenameExtension("log_");
google::InstallFailureSignalHandler();
google::InstallFailureWriter(&FatalMessageDump);
FLAGS_colorlogtostderr = true;        // Set log color
FLAGS_logbufsecs = 0;                // Set log output speed(s)
FLAGS_max_log_size = 1024;            // Set max log file size(GB)
FLAGS_stop_logging_if_full_disk = true;    // If disk is full

五、Linux/Uinux平台应用

　　下载安装包之后，输入解压命令，直接进入解压后的目录准备编译：

./configue
make
make install

　　特别提示一下，直接解压后的configure 以及相关.sh文件有可能是没有可执行权限的，用chmod a+x 给一下权限。如果要指定生成的文件路径，那么就在配置的时候输入：./configue --prefix=your_dir

　　假设你的glog库的路径为/usr/local/lib/libglog.a，头文件路径为/usr/local/include/glog/logging.h，那么编译命令如下:

g++ test.cpp -o test -L/usr/local/lib -lglog -I/usr/local/include/glog

　　glog可以采用命令行的模式配置参数，这也是它灵活易用的体现，有两种指定参数的方法，一种依赖于gflag如下：

./your_application --logtostderr=1     // 或者下面这种：
GLOG_logtostderr=1 ./your_application

　　所有的环境变量均以GLOG_开头，我们推荐使用第二种，一来不必依赖于gflag，二来当参数很多时，可以写成脚本的形式，看起来更直观，GLOG支持的flag如下（只列出常用的，如果想看全部的，可以在源码的logging.cc文件下看到）：

GLOG_logtostderr
　　bool，默认为FALSE，将日志打印到标准错误，而不是日志文件
GLOG_alsologtostderr
　　bool，默认为FALSE，将日志打印到日志文件，同时也打印到标准错误
GLOG_stderrthreshold
　　int，默认为2（ERROR），大于等于这个级别的日志才打印到标准错误，当指定这个参数时，GLOG_alsologtostderr参数将会失效
GLOG_minloglevel
　　int，默认为0（INFO）， 小于这个日志级别的将不会打印
GLOG_log_dir
　　string类型，指定日志输出目录，目录必须存在
GLOG_max_log_size
　　int，指定日志文件最大size，超过会被切割，单位为MB
GLOG_stop_logging_if_full_disk
　　bool，默认为FALSE，当磁盘满了之后不再打印日志
GLOG_v
　　int，默认为0，指定GLOG_v=n时，对vlog(m)，当m<=n时才会打印日志

　　知道了这些参数之后，我们可以在脚本中指定这些变量，还是以test程序为例，test.sh如下：

#!/bin/sh
export GLOG_log_dir=log
export GLOG_minloglevel=1
export GLOG_stderrthreshold=1
export GLOG_v=3
export GLOG_max_log_size=1
./test