python模块之logging

　　服务崩溃后，如果没有日志，我几乎没办法知道到底发生了错误。日志不仅对于服务器很重要，对于桌面图形应用同样十分重要。比如，当你的客户的 PC 机程序崩溃时，你可以让他们把日志文件发给你，这样你就可以找到问题到底出在哪儿。相信我，在不同的 PC 环境下，你永远不会知道会有怎样奇怪的问题。我曾经就接收到过这样的错误日志。

2011-08-22 17:52:54,828 - root - ERROR - [Errno 10104] getaddrinfo failed
Traceback (most recent call last):
  File "", line 124, in main
  File "", line 20, in __init__
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/wx._core", line 7978, in __init__
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/wx._core", line 7552, in _BootstrapApp
  File "", line 84, in OnInit
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/twisted.internet.wxreactor", line 175, in install
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/twisted.internet._threadedselect", line 106, in __init__
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/twisted.internet.base", line 488, in __init__
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/twisted.internet.posixbase", line 266, in installWaker
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/twisted.internet.posixbase", line 74, in __init__
  File "h:workspaceprojectbuildpyi.win32mrdjoutPYZ1.pyz/socket", line 224, in meth
gaierror: [Errno 10104] getaddrinfo failed

　　我最终发现，这个客户的 PC 机被一种病毒感染，导致了调用 gethostname 函数失败。看吧，如果没有日志可以查你怎么可能知道这些。

打印输出不是个好办法

　　尽管记录日志非常重要，但是并不是所有的开发者都能正确地使用它。我曾看到一些开发者是这样记录日志的，在开发的过程中插入 print 语句，开发结束后再将这些语句移除。就像这样:

print &＃39;Start reading database&＃39;
records = model.read_recrods()
print &＃39;# records&＃39;, records
print &＃39;Updating record ...&＃39;
model.update_records(records)
print &＃39;done&＃39;

　　这种方式对于简单脚本型程序有用，但是如果是复杂的系统，你最好不要使用这样的方式。首先，你没办法做到在日志文件中只留下极其重要的消息。你会看到大量的消息日志。但是你却找不到任何有用的信息。你除了移除这输出语句这外，没别的办法控制代码，但是极有可能的是你忘记了移出那些没用的输出。再者，print 输出的所有信息都到了标准输出中，这将严重影响到你从标准输出中查看其它输出数据。当然，你也可以把消息输出到 stderr ，但是用 print 做日志记录的方式还是不好。

使用 python 的标准日志模块

　　那么，怎么样记录日志才是正确的呢？其实非常简单，使用 python 的标准日志模块。多亏 python 社区将日志做成了一个标准模块。它非常简单易用且十分灵活。你可以像这样使用日志系统：

import logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

logger.info(&＃39;Start reading database&＃39;)
# read database here

records = {&＃39;john&＃39;: 55, &＃39;tom&＃39;: 66}
logger.debug(&＃39;Records: %s&＃39;, records)
logger.info(&＃39;Updating records ...&＃39;)
# update records here

logger.info(&＃39;Finish updating records&＃39;)

运行的时候就可看到：

INFO:__main__:Start reading database
INFO:__main__:Updating records ...
INFO:__main__:Finish updating records

你可能会问这与使用 print 有什么不同呢。它有以下的优势：

你可以控制消息的级别，过滤掉那些并不重要的消息。

你可决定输出到什么地方，以及怎么输出。

　　有许多的重要性别级可供选择，debug、info、warning、error 以及 critical。通过赋予 logger 或者 handler 不同的级别，你就可以只输出错误消息到特定的记录文件中，或者在调试时只记录调试信息。让我们把 logger 的级别改成 DEBUG 再看一下输出结果：

 logging.basicConfig(level=logging.DEBUG)

输出变成了：

INFO:__main__:Start reading database
DEBUG:__main__:Records: {&＃39;john&＃39;: 55, &＃39;tom&＃39;: 66}
INFO:__main__:Updating records ...
INFO:__main__:Finish updating records

　　正如看到的那样，我们把 logger 的等级改为 DEBUG 后，调试记录就出现在了输出当中。你也可以选择怎么处理这些消息。例如，你可以使用 FileHandler 把记录写进文件中：

import logging

logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)

# create a file handler

handler = logging.FileHandler(&＃39;hello.log&＃39;)
handler.setLevel(logging.INFO)

# create a logging format

formatter = logging.Formatter(&＃39;%(asctime)s - %(name)s - %(levelname)s - %(message)s&＃39;)
handler.setFormatter(formatter)

# add the handlers to the logger

logger.addHandler(handler)

logger.info(&＃39;Hello baby&＃39;)

以合适的等级输出日志记录

　　有了灵活的日志记录模块后，你可以按适当的等级将日志记录输出到任何地方然后配置它们。那么你可能会问，什么是合适的等级呢？在这儿我将分享一些我的经验。

大多数的情况下，你都不想阅读日志中的太多细节。因此，只有你在调试过程中才会使用 DEBUG 等级。我只使用 DEBUG 获取详细的调试信息，特别是当数据量很大或者频率很高的时候，比如算法内部每个循环的中间状态。

def complex_algorithm(items):
    for i, item in enumerate(items):
        # do some complex algorithm computation

       logger.debug(&＃39;%s iteration, item=%s&＃39;, i, item)

在处理请求或者服务器状态变化等日常事务中，我会使用 INFO 等级。

def handle_request(request):
    logger.info(&＃39;Handling request %s&＃39;, request)
    # handle request here

    result = &＃39;result&＃39;
    logger.info(&＃39;Return result: %s&＃39;, result)

def start_service():
    logger.info(&＃39;Starting service at port %s ...&＃39;, port)
    service.start()
    logger.info(&＃39;Service is started&＃39;)

当发生很重要的事件，但是并不是错误时，我会使用 WARNING 。比如，当用户登录密码错误时，或者连接变慢时。

def authenticate(user_name, password, ip_address):
     if user_name != USER_NAME and password != PASSWORD:
        logger.warn(&＃39;Login attempt to %s from IP %s&＃39;, user_name, ip_address)
        return False
    # do authentication here

有错误发生时肯定会使用 ERROR 等级了。比如抛出异常，IO 操作失败或者连接问题等。

def get_user_by_id(user_id):
    user = db.read_user(user_id)
    if user is None:
        logger.error(&＃39;Cannot find user with user_id=%s&＃39;, user_id)
        return user
    return user

我很少使用 CRITICAL 。当一些特别糟糕的事情发生时，你可以使用这个级别来记录。比方说，内存耗尽，磁盘满了或者核危机（希望永远别发生 :S）。

　　虽然不是非得将 logger 的名称设置为 __name__ ，但是这样做会给我们带来诸多益处。在 python 中，变量 __name__ 的名称就是当前模块的名称。比如，在模块 “foo.bar.my_module” 中调用 logger.getLogger(__name__) 等价于调用logger.getLogger(“foo.bar.my_module”) 。当你需要配置 logger 时，你可以配置到 “foo” 中，这样包 foo 中的所有模块都会使用相同的配置。当你在读日志文件的时候，你就能够明白消息到底来自于哪一个模块。

捕捉异常并使用 traceback 记录它

　　出问题的时候记录下来是个好习惯，但是如果没有 traceback ，那么它一点儿用也没有。你应该捕获异常并用 traceback 把它们记录下来。比如下面这个例子：

try:
    open(&＃39;/path/to/does/not/exist&＃39;, &＃39;rb&＃39;)
except (SystemExit, KeyboardInterrupt):
    raise
except Exception, e:
    logger.error(&＃39;Failed to open file&＃39;, exc_info=True)

使用参数 exc_info=true 调用 logger 方法, traceback 会输出到 logger 中。你可以看到下面的结果

 ERROR:__main__:Failed to open file
 Traceback (most recent call last):
   File "example.py", line 6, in 
    open(&＃39;/path/to/does/not/exist&＃39;, &＃39;rb&＃39;)
 IOError: [Errno 2] No such file or directory: &＃39;/path/to/does/not/exist&＃39;

Python 使用logging模块记录日志涉及四个主要类，使用官方文档中的概括最为合适：

logger提供了应用程序可以直接使用的接口；

handler将(logger创建的)日志记录发送到合适的目的输出；

filter提供了细度设备来决定输出哪条日志记录；

formatter决定日志记录的最终输出格式。

logging模块是在2.3新引进的功能，下面是一些常用的类和模块级函数

模块级函数
logging.getLogger([name]):返回一个logger对象，如果没有指定名字将返回root logger
logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()：设定root logger的日志级别
logging.basicConfig():用默认Formatter为日志系统建立一个StreamHandler，设置基础配置并加到root logger中

11) logging.handlers.HTTPHandler

# encoding:utf-8
#import logging

#FORMAT = &＃39;%(asctime)-15s %(clientip)s %(user)-8s %(message)s&＃39;
#logging.basicConfig(format=FORMAT)
#d = {&＃39;clientip&＃39;: &＃39;192.168.0.1&＃39;, &＃39;user&＃39;: &＃39;fbloggs&＃39;}
#logger = logging.getLogger(&＃39;tcpserver&＃39;)
#logger.warning(&＃39;Protocol problem: %s&＃39;, &＃39;connection reset&＃39;, extra=d)

#FORMAT = &＃39;%(asctime)-15s %(message)s&＃39;
#logging.basicConfig(filename = "C:\\Users\\june\\Desktop\\1.txt", level = logging.DEBUG, filemode = "a", format=FORMAT)  
#logging.debug(&＃39;this is a message&＃39;)  
#logging.debug(&＃39;test&＃39;)  

#import logging
#import datetime
#
#curDate = datetime.date.today() - datetime.timedelta(days=0)
#logName =  &＃39;C:\\Users\\june\\Desktop\\error_%s.log&＃39; %curDate
#
#logging.basicConfig(level=logging.INFO,
#                format=&＃39;%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s&＃39;,
#                #datefmt=&＃39;%a, %d %b %Y %H:%M:%S&＃39;,
#                filename=logName,
#                filemode=&＃39;a&＃39;)
#
##2013-10-21 03:25:51,509 writeLog.py[line:14] INFO This is info message
##2013-10-21 03:25:51,510 writeLog.py[line:15] WARNING This is warning message
#logging.debug(&＃39;This is debug message&＃39;)
#logging.info(&＃39;This is info message&＃39;)
#logging.warning(&＃39;This is warning message&＃39;)import logging
import logging.config

logging.config.fileConfig("logging.conf")

#create logger
loggerInfo = logging.getLogger("infoLogger")

#"application" code
loggerInfo.debug("debug message")
loggerInfo.info("info message")
loggerInfo.warn("warn message")
loggerInfo.error("error message")
loggerInfo.critical("critical message")


loggerError = logging.getLogger("errorLogger")
loggerError.error("Error: Hello world!")

#coding=utf-8
import logging
import datetime

format=&＃39;%(asctime)s - %(filename)s - [line:%(lineno)d] - %(levelname)s - %(message)s&＃39;
curDate = datetime.date.today() - datetime.timedelta(days=0)
infoLogName =  r&＃39;C:/Users/june/Desktop/info_%s.log&＃39; %curDate
errorLogName =  r&＃39;C:/Users/june/Desktop/error_%s.log&＃39; %curDate

formatter = logging.Formatter(format)

infoLogger = logging.getLogger("infoLog")
errorLogger = logging.getLogger("errorLog")

infoLogger.setLevel(logging.INFO)
errorLogger.setLevel(logging.ERROR)

infoHandler = logging.FileHandler(infoLogName, &＃39;a&＃39;)
infoHandler.setLevel(logging.INFO)
infoHandler.setFormatter(formatter)

errorHandler = logging.FileHandler(errorLogName, &＃39;a&＃39;)
errorHandler.setLevel(logging.ERROR)
errorHandler.setFormatter(formatter)

testHandler = logging.StreamHandler()
testHandler.setFormatter(formatter)
testHandler.setLevel(logging.ERROR)

infoLogger.addHandler(infoHandler)
infoLogger.addHandler(testHandler)
errorLogger.addHandler(errorHandler)

#infoLogger.debug("debug message")
#infoLogger.info("info message")
#infoLogger.warn("warn message")
# # 下面这行会同时打印在文件和终端上
#infoLogger.error("error message")
#
#errorLogger.error("error message")
#errorLogger.critical("critical message")

&＃39;&＃39;&＃39;
Created on 2016年8月18日

@author: apple
&＃39;&＃39;&＃39;
#-*- coding:utf-8 -*-

#开发出一个日志系统，既要把日志输出到控制台，还要写入日志文件

import logging
import time
import os
import os.path

class Logger():
    def __init__(self, log_name, logger_name):
        
        &＃39;&＃39;&＃39;
                指定保存日志的文件路径，日志级别以及调用文件
                将日志    存入到指定的文件中
    
        &＃39;&＃39;&＃39;
        #设置日志文件名称：time.time()取得当前时间；time.localtime()取得本地时间；time.strftime()格式化日期；
        time_str = time.strftime("%Y_%m_%d_%H_%M_%S", time.localtime(time.time()))
        logname = time_str + &＃39;_&＃39; + log_name + &＃39;.log&＃39;
        
        #设置日志文件所在的路径
        log_filedir = &＃39;Log&＃39;
        if not os.path.isdir(log_filedir):
            print("日志文件夹 %s 不存在，开始创建此文件夹" %log_filedir)
            os.mkdir(&＃39;Log&＃39;)
        else:
            print("日志文件夹 %s 存在" %log_filedir)
        
        os.chdir(&＃39;Log&＃39;)
        
        #创建一个logger以及设置日志级别
        #logging有6个日志级别:NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL对应的值分别为：0,10,20,30,40,50
        #例如:logging.DEBUG和10是等价的表示方法
        #可以给日志对象(Logger Instance)设置日志级别，低于该级别的日志消息将会被忽略，也可以给Hanlder设置日志级别
        #对于低于该级别的日志消息, Handler也会忽略。
        self.logger = logging.getLogger(logger_name)
        self.logger.setLevel(logging.DEBUG)
        
        #创建文件handler，用于写入日志文件并设置文件日志级别
        file_handler = logging.FileHandler(logname)
        file_handler.setLevel(logging.DEBUG)
        
        #创建控制端输出handler，用于输出到控制端并设置输出日志级别
        console_handler = logging.StreamHandler()
        console_handler.setLevel(logging.DEBUG)
        
        #在控制端handler添加过滤器，将含有chat或者gui的handler信息输出
        filter = logging.Filter("chat.gui")
        console_handler.addFilter(filter)
        
        #定义handler的输出格式并将格式应用到handler
        formatter = logging.Formatter(&＃39;%(asctime)s-%(name)s-%(levelname)s-%(message)s&＃39;)
        file_handler.setFormatter(formatter)
        console_handler.setFormatter(formatter)
        
        #将handler加入到logger
        self.logger.addHandler(file_handler)
        self.logger.addHandler(console_handler)
        
        self.logger.debug("这个是debug日志信息")
        self.logger.info("欢迎大家来到 Python的世界")
        
        
        #将handler从logger中移除
        self.logger.removeHandler(file_handler)
        self.logger.removeHandler(console_handler)

if __name__ == &＃39;__main__&＃39;:       
    print(os.getcwd())
    Log = Logger(&＃39;create_log&＃39;, "chat.gui.statistic")
        


# 模块级函数
# 
# logging.getLogger([name]):返回一个logger对象，如果没有指定名字将返回root logger
# logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()：设定root logger的日志级别
# logging.basicConfig():用默认Formatter为日志系统建立一个StreamHandler，设置基础配置并加到root logger中
# 
# Loggers
# 
# Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高
# Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
# Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler
# Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别

# Handlers
# 
# handler对象负责发送相关的信息到指定目的地。可以通过addHandler()方法添加多个多handler
# Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
# Handler.setFormatter()：给这个handler选择一个格式
# Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

# Formatters
# 
# Formatter对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些信息


# %(name)s                       Logger的名字
#  
# %(levelno)s                    数字形式的日志级别
#  
# %(levelname)s                文本形式的日志级别
#  
# %(pathname)s                调用日志输出函数的模块的完整路径名，可能没有
# 
# %(filename)s                  调用日志输出函数的模块的文件名
#  
# %(module)s                    调用日志输出函数的模块名
#  
# %(funcName)s                调用日志输出函数的函数名
#  
# %(lineno)d                     调用日志输出函数的语句所在的代码行
#  
# %(created)f                    当前时间，用UNIX标准的表示时间的浮 点数表示
#  
# %(relativeCreated)d        输出日志信息时的，自Logger创建以 来的毫秒数
#  
# %(asctime)s                  字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
# 
# %(thread)d                   线程ID。可能没有
# 
# %(threadName)s           线程名。可能没有
# 
# %(process)d                 进程ID。可能没有
#  
# %(message)s               用户输出的消息

&＃39;&＃39;&＃39;
Created on 2016年8月25日

@author: apple
&＃39;&＃39;&＃39;
import logging

logging.basicConfig(level=logging.INFO,
                    format=&＃39;%(asctime)s %(name)s %(levelname)s %(message)s&＃39;,
                    datefmt=&＃39;%m-%d %H:%M&＃39;,
                    filename=&＃39;./AutoUpdate.log&＃39;,
                    filemode=&＃39;w&＃39;)

cOnsole= logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter(&＃39;%(name)s: %(levelname)-8s %(message)s&＃39;)
console.setFormatter(formatter)
logging.getLogger(&＃39;&＃39;).addHandler(console)

logging.info("hello world!")