python logging模块

Posted 2020-10-27 wj-1314

　　很多程序员都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误，警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种各样的日志，你可以通过它存储各种格式的日志，logging的日志可以分为debug(),info(),warning(),error() 和 critical()五个级别。

　　默认情况下Python的logging模块将日志打印到了标准输出中，且只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING（日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG），默认的日志格式为日志级别：Logger名称：用户输出消息。

一，logging模块简介

　　logging模块是Python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等；相比print，具备如下优点：

1. 可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；
2. print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出；

二，基本用法

import logging  
logging.debug(‘debug message‘)  
logging.info(‘info message‘)  
logging.warning(‘warning message‘)  
logging.error(‘error message‘)  
logging.critical(‘critical message‘)  

　输出结果：

WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message

　　可见，默认情况下Python 的 logging 模块将日志打印到了标准输出中，且只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING（日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET），默认的日志格式为日志级别：Logger名称：用户输出消息。

三，灵活配置日志级别，日志格式，输出位置

import logging  
logging.basicConfig(level=logging.DEBUG,  
                    format=‘%(asctime)s %(filename)s[line:%(lineno)d] 
                                %(levelname)s %(message)s‘,  
                    datefmt=‘%a, %d %b %Y %H:%M:%S‘,  
                    filename=‘test.log‘,  
                    filemode=‘w‘)  
  
logging.debug(‘debug message‘)  
logging.info(‘info message‘)  
logging.warning(‘warning message‘)  
logging.error(‘error message‘)  
logging.critical(‘critical message‘)            

　　在test.log中查看输出：

Wed, 14 Mar 2018 09:39:09 log模块.py[line:24] DEBUG debug message
Wed, 14 Mar 2018 09:39:09 log模块.py[line:25] INFO info message
Wed, 14 Mar 2018 09:39:09 log模块.py[line:26] WARNING warning message
Wed, 14 Mar 2018 09:39:09 log模块.py[line:27] ERROR error message
Wed, 14 Mar 2018 09:39:09 log模块.py[line:28] CRITICAL critical message

　　可见在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为，可用参数有

filename：用指定的文件名创建FiledHandler（后边会具体讲解handler的概念），
                这样日志会被存储在指定的文件中。

filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。

format：指定handler使用的日志显示格式。 

datefmt：指定日期时间格式。 

level：设置rootlogger（后边会讲解具体概念）的日志级别 

stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout
            或者文件(f=open(‘test.log‘,‘w‘))，默认为sys.stderr。
            若同时列出了filename和stream两个参数，则stream参数会被忽略。

format参数中可能用到的格式化串：
%(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用户输出的消息    

四，logger对象

　　 上述几个例子中我们了解到了logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()（分别用以记录不同级别的日志信息），logging.basicConfig()（用默认日志格式（Formatter）为日志系统建立一个默认的流处理器（StreamHandler），设置基础配置（如日志级别等）并加到root logger（根Logger）中）这几个logging模块级别的函数，另外还有一个模块级别的函数是logging.getLogger([name])（返回一个logger对象，如果没有指定名字将返回root logger）

     先看一个最简单的过程：

# _*_ coding: utf-8 _*_ 
import logging

logger = logging.getLogger()
# 创建一个handler，用于写入日志文件,文件输出对象
fh = logging.FileHandler(‘test1.log‘)

# 再创建一个handler，用于输出到控制台 ，屏幕输出对象
ch = logging.StreamHandler()

#format 是输出格式
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)

fh.setFormatter(formatter)
ch.setFormatter(formatter)

logger.addHandler(fh) #logger对象可以添加多个fh和ch对象
logger.addHandler(ch)

logger.debug(‘logger debug message‘)
logger.info(‘logger info message‘)
logger.warning(‘logger warning message‘)
logger.error(‘logger error message‘)
logger.critical(‘logger critical message‘)

　　结果：

2018-03-14 10:19:39,478 - root - WARNING - logger warning message
2018-03-14 10:19:39,478 - root - ERROR - logger error message
2018-03-14 10:19:39,478 - root - CRITICAL - logger critical message

4.1  将日志写入文件

　　设置logging，创建一个FileHandler，并对输出消息的格式进行设置，将其添加到logger，然后将日志写入到指定的文件中，

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

　　log.txt中日志输出数据为：

2018-03-14 22:47:14,497 - __main__ - INFO - Start print log
2018-03-14 22:47:14,523 - __main__ - WARNING - Something maybe fail.
2018-03-14 22:47:14,523 - __main__ - INFO - Finish

　　

五，日志同时输出到屏幕和文件

　　如果想同时把log打印到屏幕和文件日志里面，就需要了解一点复杂的知识了

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

• logger提供了应用程序可以直接使用的接口
• handle将（logger创建的）日志记录发送到合适的目的输出
• filter提供了细节设备来决定输出哪条日志记录
• formatter决定日志记录的最终输出格式

他们之间的关系如下：

 logger

每个程序在输出信息之前都要获得一个Logger，Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：

LOG = logging.getLogger("chat,gui")

而核心模块可以这样：

LOG=logging.getLogger(”chat.kernel”)

　　还可以绑着handle 和 filters

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()：可以设置的日志级别

handler

handler对象负责发送相关的信息到指定目的地，Python的日志系统有多种Handler可以使用，有些handler可以把信息输出到控制台，有些Handler可以把信息输出到文件，还有些Handler可以把信息发送到网络上，如果觉得不够用，还可以编写自己的Handler，可以通过addHandler（）方法添加多个Handler

Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

　　每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：

1，logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。

2，logging.FileHandler 和StreamHandler 类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件

3，logging.handlers.RotatingFileHandler

这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的函数是：

 

RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

　　

其中filename和mode两个参数和FileHandler一样。

• maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
• backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4，logging.handlers.TimedRotatingFileHandler

这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的函数是：

TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

　　其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。

　　interval是时间间隔

　　when参数是一个字符串，表示时间间隔的单位，不区分大小写，它有以下取值：

S 秒
M 分
H 小时
D 天
W 每星期（interval==0时代表星期一）
midnight 每天凌晨

　　

formatter组件

　　日志的formatter是个独立的组件，可以根handler组合

fh = logging.FileHandler("access.log")
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)

fh.setFormatter(formatter) #把formmater绑定到fh上

　　

filter组件

如果你相对日志文件内容进行过滤，就可以自定义一个filter

class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""
    def filter(self, record): #固定写法
        return   "db backup" not in record.getMessage()

　　注意filter函数会返加True or False，logger根据此值决定是否输出此日志

然后把这个filter添加到logger中

logger.addFilter(IgnoreBackupLogFilter())

　　下面的日志就会把符合filter条件的过滤掉

logger.debug("test ....")
logger.info("test info ....")
logger.warning("start to run db backup job ....")
logger.error("test error ....")

六，应用实例　

6.1 一个同时输出到屏幕、文件、带filter的完成例子

import logging



class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""
    def filter(self, record): #固定写法
        return   "db backup" not in record.getMessage()




#console handler
ch = logging.StreamHandler()
ch.setLevel(logging.INFO)
#file handler
fh = logging.FileHandler(‘mysql.log‘)
#fh.setLevel(logging.WARNING)


#formatter
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
#bind formatter to ch
ch.setFormatter(formatter)
fh.setFormatter(formatter)

logger = logging.getLogger("Mysql")
logger.setLevel(logging.DEBUG) #logger 优先级高于其它输出途径的


#add handler   to logger instance
logger.addHandler(ch)
logger.addHandler(fh)



#add filter
logger.addFilter(IgnoreBackupLogFilter())

logger.debug("test ....")
logger.info("test info ....")
logger.warning("start to run db backup job ....")
logger.error("test error ....")

　

6.2  文件自动截断例子

import logging

from logging import handlers

logger = logging.getLogger(__name__)

log_file = "timelog.log"
#fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)


formatter = logging.Formatter(‘%(asctime)s %(module)s:%(lineno)d %(message)s‘)

fh.setFormatter(formatter)

logger.addHandler(fh)


logger.warning("test1")
logger.warning("test12")
logger.warning("test13")
logger.warning("test14")

　　

6.3  应用到atm程序中日志文件的例子

import os
import time
import logging
from config import settings


def get_logger(card_num, struct_time):

    if struct_time.tm_mday < 23:
        file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon, 22)
    else:
        file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon+1, 22)

    file_handler = logging.FileHandler(
        os.path.join(settings.USER_DIR_FOLDER, card_num, ‘record‘, file_name),
        encoding=‘utf-8‘
    )
    fmt = logging.Formatter(fmt="%(asctime)s :  %(message)s")
    file_handler.setFormatter(fmt)

    logger1 = logging.Logger(‘user_logger‘, level=logging.INFO)
    logger1.addHandler(file_handler)
    return logger1