Google GLog 的使用详解.docxVIP

Google GLog 的使用详解HowToUseGoogleLoggingLibraryGlog的基本使用方法在googlecode上有介绍：HowToUseGoogleLoggingLibrary;最好有VPN，不然访问的时候估计又是加载不了，吐槽下GFW；以下对上述文档的翻译大部分来自：Glog使用帮助，这位哥们写的也是转的，但是没出处，所以原文在出自哪里我也不清楚，感谢不知名人士。少部分来自我自己的补充，有不对之处希望指出；1.概述Googleglog是一个基于程序级记录日志信息的c+库，编程使用方式与c+的stream操作类似，例：LOG(INFO)Foundnum_cookiescookies;“LOG”宏为日志输出关键字，“INFO”为严重性程度。主要支持功能：1，参数设置，以命令行参数的方式设置标志参数来控制日志记录行为；2，严重性分级，根据日志严重性分级记录日志；3，可有条件地记录日志信息；4，条件中止程序。丰富的条件判定宏，可预设程序终止条件；5，异常信号处理。程序异常情况，可自定义异常处理过程；6，支持debug功能。可只用于debug模式；7，自定义日志信息；8，线程安全日志记录方式；9，系统级日志记录；10，googleperror风格日志信息；11，精简日志字符串信息。2.功能使用1.1参数设置可通过命令行方式设置glog的标志参数，用来控制日志记录行为。命令格式如下：标志名1=标志值标志名2=标志值标志值n=标志值./程序名所有标志名需添加统一前缀“GLOG_”，不同标志语句之间以空格相隔；例如：-GLOG_vmodule=mapreduce=2,file=1,gfs*=3-GLOG_v=0./application.exe常用标志参数类型及其作用说明：标志参数类型作用logtostderrbool值为true的时候，日志信息输出到stderr，并非文件。默认值为false。stderrthresholdint严重性级别在该门限值以上的日志信息除了写入日志文件以外，还要输出到stderr。各严重性级别对应的数值：INFO0，WARNING1，ERROR2，FATAL3默认值为2.minloglevelint严重性级别在该门限值以上的日志信息才进行记录。默认值为0.log_dirstring日志信息记录路径。默认为空，如果没有指定信息输出到stderr，则信息保存在/tmp/.log.文件中。(e.g.,/tmp/hello_.hamaji.log.INFO.20080709-222411.10474).vint对于使用“VLOG(m)”（m为int型）表达式进行输出的日志信息，只在m的值小于该标志的值的时候，才进行输出。另外，该设置可能被vmodule标志给覆盖.默认为0.vmodulestring分模块（文件）设置VLOG(m)日志信息的输出基本。命令格式为以逗号分开的“=”表达式组成。其中是“globpattern”，支持通配符，不包括文件的扩展名（.h,.cc等）。表1标志说明还有其他的标志参数定义在logging.cc，可在文件中搜索“DEFINE_”来进行查看。1.2严重性分级记录信息glog可通过根据指定的严重性等级，来选择性记录日志。日志信息严重性等级按由低到高排列依次为：INFO,WARNING,ERROR,和FATAL四级。使用者可以在命令行中设置严重性等级门限值来控制日志的输出，详细见“参数设置”部分的“minloglevel”标志值的介绍。1.3有条件地记录日志信息glog可以控制日志信息在指定条件下进行记录。具体使用如下：1，LOG_IF(INFO,num_cookies10)10条件成立时，“Gotlotsofcookies”日志信息才被记录。2，LOG_EVERY_N(INFO,10)GottheCOUNTER1024),10)GottheCOUNTER1024的条件连续成立10次的时候记录日志信息。COUNTER变量表示该条件成立的次数。4，LOG_FIRST_N(INFO,20)GottheCOUNTERWrite(x)=4)Write(x)=4成立时，记录“Writefailed!”日志信息，并且中止程序，其中fp-Write(x)=4为判定条件，日志信息以c+的stream操作形式生成。glog提供了多个便利的宏来处理特定关系的判定。具体有：1,判定大小关系CHECK_EQ,CHECK_NE,CHECK_LE,CHECK_LT,CHECK_GE,CHECK_GT，使用这些宏需要注意类型一致，如果出现类型不一致的，可使用static_cast转换。2,判定指针是否为空CHECK_NOTNULL（some_ptr），可用于对象初始化的时候。3，判定字符串是否相等CHECK_STREQ,CHECK_STRNE,CHECK_STRCASEEQ,CHECK_STRCASENE。可进行大小写敏感或不敏感字符串来分别判定。4，判定浮点是否相等或相近CHECK_DOUBLE_EQ，CHECK_NEAR。这两个宏都需要指定一个可容忍的偏差上限。当这些宏判定条件不成立时，glog会生成一个FATAL级别的日志信息，该信息包含比较的两个值和stream方式传入的字符串，然后中止程序。1.5异常信号处理glog提供了比较方便的程序异常处理机制。例如，当程序出现SIGSEGV异常信号时，glog的默认异常处理过程会导出非常有用的异常信息。异常处理过程可以通过google:InstallFailureSignalHandler()来自定义。下面为异常处理过程的输出例子：*Abortedat1225095260(unixtime)trydate-d1225095260ifyouareusingGNUdate*SIGSEGV(0x0)receivedbyPID17711(TID0x7f893090a6f0)fromPID0;stacktrace:*PC:0x412eb1TestWaitingLogSink:send()0x7f892fb417d0(unknown)0x412eb1TestWaitingLogSink:send()0x7f89304f7f06google:LogMessage:SendToLog()0x7f89304f35afgoogle:LogMessage:Flush()0x7f89304f3739google:LogMessage:LogMessage()0x408cf4TestLogSinkWaitTillSent()0x4115demain0x7f892f7ef1c4(unknown)0x4046f9(unknown)默认情况下，异常信息是输出到stderr，通过InstallFailureWriter（）可以改变输出目标。1.6支持debug功能glog提供特定的宏只在debug模式下生效。以下分别对应LOG、LOG_IF、DLOG_EVERY_N操作的专用宏。DLOG(INFO)10)Gotlotsofcookies;DLOG_EVERY_N(INFO,10)GottheCOUNTER1024)1024成立时且命令行参数v的值不小于1，才记录日志信息。VLOG_EVERY_N(1,10)Imprintedevery10thoccurrence,andwhenyouruntheprogramwith-v=1ormore.Presentoccurenceis1024),10)Imprintedonevery10thoccurenceofcasewhensizeismorethan1024,whenyouruntheprogramwith-v=1ormore.;Presentoccurenceis1024条件连续成立10次，记录一次日志信息。1.8线程安全日志记录glog提供了线程安全的日志记录方式。在文件中提供了相关的宏，如，RAW_CHECK，RAW_LOG等。这些宏的功能与CHECK，LOG等一致，除此以外支持线程安全，不需要为其分配任何内存和提供额外的锁（lock）机制。1.9系统级日志记录glog除了提供了普通的日志记录宏，还提供SYSLOG,SYSLOG_IF,和SYSLOG_EVERY_N宏，这些宏将日志信息通过syslog()函数记录到系统日志。这个貌似只支持linux，windows编译的时候无法通过，报的错的是找不到syslog()函数，而且使用到的syslog.h也找不到；1.10googleperror风格日志信息glog提供了与LOG*和CHECK宏作用等价的PLOG()、PLOG_IF()和PCHECK()宏，不同的是，后者在记录日志信息的时候，会将errno的状态及其描述附加到日志描述中。如：PCHECK(write(1,NULL,2)=0)=0WriteNULLfailed:Badaddress141.11精简日志字符串信息日志信息的字符串会占用比较大的内存空间，另外还带来隐私泄露的问题。glog提供了GOOGLE_STRIP_LOG宏在编译时候去除日志的字符串信息。3.其他说明1，windows平台使用注意因为glog的严重性级别中使用了ERROR宏，与文件中冲突，可通过以下两种方式避免：a,在包含文件之前，定义宏WIN32_LEAN_AND_MEAN或者NOGDI。b,在包含文件之后，undef掉ERROR定义。2，FLAGS_V编译的时候报错errorLNK2001:unresolvedexternalsymbol需要包含这两个头文件#includeconfig_for_unittests.h#includeutilities.h4.基本代码using namespace GOOGLE_NAMESPACE; /必须包含int main(int argc,char *argv)google:InitGoogleLogging(argv0); /初始化log，参数argv0就是程序名/ 像下面对INFO、ERROR、WARNING 三个级别的错误日志都指明了存放位置，如果是同一个位置的话三个文件会合在一起成为一个文件；假设我们只指定INFO文件位置的话，在指定位置的日志里我们可以看到文件中包含的日志也有ERROR、WARNING，但是在windows TEMP 目录下也会生成两个文件，一个是WARING，一个是ERROR；google:SetLogDestination(google:INFO,installPath.c_str(); /INFO级别的日志都存放到installPath目录下google:SetLogDestination(google:ERROR,installPath.c_str();/ERROR级别的日志都存放到installPath目录下google:SetLogDestination(google:WARNING,installPath.c_str();/WARNING级别的日志都存放到installPath目录下google:SetStderrLogging(google:INFO); /输出到标准输出的时候大于INFO级别的都输出；FLAGS_logbufsecs = 0; /日志实时输出FLAGS_max_log_size = 1024; / max log size is 1024Mreturn 0;初始化日志模块的时候设置一些以下的参数在头文件src/glog/logging.h中/ Set whether log messages go to stderr instead of logfilesDECLARE_bool(logtostderr);/ Set whether log messages go to stderr in addition to logfiles.DECLARE_bool(alsologtostderr);/ Set color messages logged to stderr (if supported by terminal).DECLARE_bool(colorlogtostderr);/ Log messages at a level = this flag are automatically sent to/ stderr in addition to log files.DECLARE_int32(stderrthreshold);/ Set whether the log prefix should be prepended to each line of output.DECLARE_bool(log_prefix);/ Log messages at a level = this flag are buffered./ Log messages at a higher level are flushed immediately.DECLARE_int32(logbuflevel);/ Sets the maximum number of seconds which logs may be buffered for.DECLARE_int32(logbufsecs);/ Log suppression level: messages logged at a lower level than this/ are suppressed.DECLARE_int32(minloglevel);/ If specified, logfiles are written into this directory instead of the/ default logging directory.DECLARE_string(log_dir);/ Sets the path of the directory into which to put additional links/ to the log files.DECLARE_string(log_link);DECLARE_int32(v); / in vlog_is_on.cc/ Sets the maximum log file size (in MB).DECLARE_int32(max_log_size);/ Sets whether to avoid logging to the disk if the disk is full.DECLARE_bool(stop_logging_if_full_disk);int64 base_num_infos = LogMessage:num_messages(GLOG_INFO); /INFO 级别日志数量int64 base_num_warning = LogMessage:num_messages(GLOG_WARNING); /WARNING级别日志数量int64 base_num_errors = LogMessage:num_messages(GLOG_ERROR); /ERROR级别日志数量for ( int i = 0; i 10; +i ) int old_errno = errno;errno = i;PLOG_EVERY_N(ERROR, 2) Plog every 2, iteration COUNTER; errno = old_errno;LOG_EVERY_N(ERROR, 3) Log every 3, iteration COUNTER endl;LOG_EVERY_N(ERR