python 重要的日志模块logging

一，logging模块简介

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

1. 可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；
2. print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出；
3. 将我们记录内容从记录方式中真正分离，保证了软件不同部分的合作。举个例子，他允许一个框架或者库的开发者增加日志并且让系统管理员或者负责运行配置的人员决定稍后应该记录什么。

logging模块主要分为四个部分：

• Loggers：提供应用程序直接使用的接口
• Handlers：将Loggers产生的日志传到指定位置
• Filters：对输出日志进行过滤
• Formatters：控制输出格式

1，记录器（Logger）

　　记录器是开发者经常交互的对象，那么主要的API说明了我们想要记录的内容。

　　举个记录器的例子，我们可以分类请求发出的一条信息，而不用担心他们是如何从哪里被发出的。

2，日志记录

　　日志记录时logging模块用来满足所有需求信息的包。他们包含了需要记录日志的地方，变化的字符串，参数，请求的信息队列等信息。

　　他们都是被记录的对象，每次我们调用记录器时，都会生成这些对象。但是这些对象是如何序列化到流中的呢？那就是处理器。

3，处理器

　　处理器是将日志记录发送到其他输出终端，他们获取日志记录并用相关函数中处理他们。

　　比如，一个文件处理器将会获取一条记录，并且将它添加到文件中。

　　标准的logging模块已经具备了多种内置的处理器。例如：

　　多种文件处理器（TimeRotated, SizeRotated, Watched），可以写入文件中

1. StreamHandler 输出目标流比如 stdout 或 stderr
2. SMTPHandler 通过 email 发送日志记录
3. SocketHandler 将日志文件发送到流套接字
4. SyslogHandler、NTEventHandler、HTTPHandler及MemoryHandler等

4，格式器（Formatter）

　　各时期负责将丰富的元数据日志记录转换为字符串，如果什么都没有提供，将会有个默认的格式器。

　　一般的格式器类由logging库提供，采用模板和风格作为输入。然后占位符可以在一个logRecord对象中声明所有属性。

5，过滤器（Filters）

　　我们日志工具的最后一个对象就是过滤器。

　　过滤器允许对应该发送的日志记录进行细粒度控制。多种过滤器能同时应用在记录器和处理器中。对于一条发送的日志来说，所有的过滤器都应该通过这条记录。

　　用户可以声明他们自己的过滤器作为对象，使用filter方法获取日志记录作为输入，反馈True/False 作为输出。

6，日志级别

默认级别是WARNING，可以使用打印到屏幕上的方式记录，也可以记录到文件中。

级别	何时使用
DEBUG	详细信息，典型的调试问题时，会感兴趣
INFO	证明事情按照预期工作
WARNING	表明发生了一些意外，或者不久的将来会发生问题（如“磁盘满了”）软件还是在正常工作
ERROR	由于更严重的问题，软件已经不能执行一些功能了
CRITICAL	严重错误，表明软件已经不能继续运行了

二，基本用法

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

　　简单的输出日志

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

　　为什么这样说呢？ 我们举个简单的例子，大家一看就明白

# _*_ coding: utf-8 _*_
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

　　如何把日志写到文件里？

import logging

logging.basicConfig(filename='example.log',level=logging.INFO)
logging.debug("debug  this message should go to the log file")
logging.info('info  so should shis ')
logging.warning('warning and this ')

　　输出结果：

INFO:root:info  so should shis
WARNING:root:warning and this

　　其中下面这句中的level=loggin.INFO意思是，把日志纪录级别设置为INFO，也就是说，只有比日志是INFO或比INFO级别更高的日志才会被记录到文件里，在这个例子， 第一条日志是不会被记录的，如果希望记录debug的日志，那把日志级别改成DEBUG就行了。

　　自定义日志格式是什么？　　

　　要是感觉上面输出到文件中的日志格式忘记加上时间之类的，我们下面就加上

import logging

logging.basicConfig(
format = '%(asctime)s %(message)s',
    datefmt='%m/%d/%Y %I:%M:%S %p ;',
    filename='example.log',
    level=logging.INFO
)
logging.debug("debug  this message should go to the log file")
logging.info('info  so should shis ')
logging.warning('warning and this ')

结果：

03/20/2018 10:54:15 AM ; info  so should shis
03/20/2018 10:54:15 AM ; warning and this

　除了加时间，还可以自定义一大堆格式，下表就是所有支持的格式，可见在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用户输出的消息

　　　日志同时输出到屏幕和文件（难点）

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

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

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

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

handle将（logger创建的）日志记录发送到合适的目的输出

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

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

　　下面分别解释四个类，先简单介绍一下，logging库提供了多个组件：Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口，Handler发送日志到适当的目的地，Filter提供了过滤日志信息的方法，Formatter指定日志显示格式。

logger

　　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()：可以设置的日志级别，只有日志等级大于或等于设置的日志级别的日志才会被输出。

先看一个最简单的过程（我们就会发现，如果没有设置日志级别，那么默认显示的级别是WARNIING，，故结果只输出了大于等于WARNIING级别的信息。）：

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

logger = logging.getLogger()
#创建一个handler，用于写入日志文件
fh = logging.FileHandler('example.log')

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

formatter = logging.Formatter('%(asctime)s -%(name)s - %(levelname)s - %(message)s')

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

#logger对象可以添加多个fh和ch对象
logger.addHandler(fh)
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-20 14:59:58,743 -root - WARNING - logger warning message
2018-03-20 14:59:58,867 -root - ERROR - logger error message
2018-03-20 14:59:58,867 -root - CRITICAL - logger critical message

　　文件输出结果：

2018-03-20 14:59:58,743 -root - WARNING - logger warning message
2018-03-20 14:59:58,867 -root - ERROR - logger error message
2018-03-20 14:59:58,867 -root - CRITICAL - logger critical message

　

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 每天凌晨

　　

　　这时候我们再创建两个logger对象：

# _*_ coding: utf-8 _*_
import logging
logger = logging.getLogger()
logger1 = logging.getLogger("mylogger")
logger1.setLevel(logging.DEBUG)

logger2 = logging.getLogger("mylogger")
logger2.setLevel(logging.INFO)

#创建一个handler，用于写入日志文件
fh = logging.FileHandler('example.log')

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

formatter = logging.Formatter('%(asctime)s -%(name)s - %(levelname)s - %(message)s')

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

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

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

logger1.debug('logger1111 debug message')
logger1.info('logger1111 info message')
logger1.warning('logger1111 warning message')
logger1.error('logger1111 error message')
logger1.critical('logger1111 critical message')

logger2.debug('logger2222 debug message')
logger2.info('logger2222 info message')
logger2.warning('logger2222 warning message')
logger2.error('logger2222 error message')
logger2.critical('logger2222 critical message')

　　屏幕输出结果（文件输出结果一致，所以我们这里不贴结果了）：

2018-03-20 19:42:58,641 -mylogger - INFO - logger1111 info message
2018-03-20 19:42:58,641 -mylogger - INFO - logger1111 info message
2018-03-20 19:42:58,642 -mylogger - WARNING - logger1111 warning message
2018-03-20 19:42:58,642 -mylogger - WARNING - logger1111 warning message
2018-03-20 19:42:58,642 -mylogger - ERROR - logger1111 error message
2018-03-20 19:42:58,642 -mylogger - ERROR - logger1111 error message
2018-03-20 19:42:58,642 -mylogger - CRITICAL - logger1111 critical message
2018-03-20 19:42:58,642 -mylogger - CRITICAL - logger1111 critical message

2018-03-20 19:42:58,642 -mylogger - INFO - logger2222 info message
2018-03-20 19:42:58,642 -mylogger - INFO - logger2222 info message
2018-03-20 19:42:58,642 -mylogger - WARNING - logger2222 warning message
2018-03-20 19:42:58,642 -mylogger - WARNING - logger2222 warning message
2018-03-20 19:42:58,642 -mylogger - ERROR - logger2222 error message
2018-03-20 19:42:58,642 -mylogger - ERROR - logger2222 error message
2018-03-20 19:42:58,642 -mylogger - CRITICAL - logger2222 critical message
2018-03-20 19:42:58,642 -mylogger - CRITICAL - logger2222 critical message

　　

这里有两个个问题：

1，我们明明通过logger1.setLevel(logging.DEBUG)将logger1的日志级别设置为了DEBUG，为何显示的时候没有显示出DEBUG级别的日志信息，而是从INFO级别的日志开始显示呢？

原来logger1和logger2对应的是同一个Logger实例，只要logging.getLogger（name）中名称参数name相同则返回的Logger实例就是同一个，且仅有一个，也即name与Logger实例一一对应。在logger2实例中通过logger2.setLevel(logging.INFO)设置mylogger的日志级别为logging.INFO，所以最后logger1的输出遵从了后来设置的日志级别。

2，为什么logger1、logger2对应的每个输出分别显示两次?
       这是因为我们通过logger = logging.getLogger()显示的创建了root Logger，而logger1 = logging.getLogger('mylogger')创建了root Logger的孩子(root.)mylogger,logger2同样。而孩子,孙子，重孙……既会将消息分发给他的handler进行处理也会传递给所有的祖先Logger处理。

ok,那么现在我们把# logger.addHandler(fh)       # logger.addHandler(ch)  注释掉，我们再来看效果：

代码：

# _*_ coding: utf-8 _*_
import logging
logger = logging.getLogger()
logger1 = logging.getLogger("mylogger")
logger1.setLevel(logging.DEBUG)

logger2 = logging.getLogger("mylogger")
logger2.setLevel(logging.INFO)

#创建一个handler，用于写入日志文件
fh = logging.FileHandler('example.log')

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

formatter = logging.Formatter('%(asctime)s -%(name)s - %(levelname)s - %(message)s')

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

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

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

logger1.debug('logger1111 debug message')
logger1.info('logger1111 info message')
logger1.warning('logger1111 warning message')
logger1.error('logger1111 error message')
logger1.critical('logger1111 critical message')

logger2.debug('logger2222 debug message')
logger2.info('logger2222 info message')
logger2.warning('logger2222 warning message')
logger2.error('logger2222 error message')
logger2.critical('logger2222 critical message')

　　结果：

2018-03-20 19:46:09,772 -mylogger - INFO - logger1111 info message
2018-03-20 19:46:09,772 -mylogger - WARNING - logger1111 warning message
2018-03-20 19:46:09,772 -mylogger - ERROR - logger1111 error message
2018-03-20 19:46:09,772 -mylogger - CRITICAL - logger1111 critical message

2018-03-20 19:46:09,772 -mylogger - INFO - logger2222 info message
2018-03-20 19:46:09,772 -mylogger - WARNING - logger2222 warning message
2018-03-20 19:46:09,773 -mylogger - ERROR - logger2222 error message
2018-03-20 19:46:09,773 -mylogger - CRITICAL - logger2222 critical message

　　

　　因为我们注释了logger对象显示的位置，所以才用了默认方式，即标准输出方式。因为它的父级没有设置文件显示方式，所以在这里只打印了一次。

　　孩子,孙子，重孙……可逐层继承来自祖先的日志级别、Handler、Filter设置，也可以通过Logger.setLevel(lel)、Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)、Logger.addFilter(filt)、Logger.removeFilter(filt)。设置自己特别的日志级别、Handler、Filter。若不设置则使用继承来的值。

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 ....")

　　限制只有满足过滤规则的日志才会输出。
     比如我们定义了filter = logging.Filter('a.b.c'),并将这个Filter添加到了一个Handler上，则使用该Handler的Logger中只有名字带          a.b.c前缀的Logger才能输出其日志。

filter = logging.Filter('mylogger') 

logger.addFilter(filter)

这是只对logger这个对象进行筛选，如果想对所有的对象进行筛选，则：

      filter = logging.Filter('mylogger') 

      fh.addFilter(filter)

      ch.addFilter(filter)

      这样，所有添加fh或者ch的logger对象都会进行筛选。

完整代码一：

import logging

logger = logging.getLogger()
# 创建一个handler，用于写入日志文件
fh = logging.FileHandler('test.log')

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

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

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

# 定义一个filter
filter = logging.Filter('mylogger')
fh.addFilter(filter)
ch.addFilter(filter)

# logger.addFilter(filter)
logger.addHandler(fh)
logger.addHandler(ch)

logger.setLevel(logging.DEBUG)

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')

##################################################
logger1 = logging.getLogger('mylogger')
logger1.setLevel(logging.DEBUG)

logger2 = logging.getLogger('mylogger')
logger2.setLevel(logging.INFO)

logger1.addHandler(fh)
logger1.addHandler(ch)

logger2.addHandler(fh)
logger2.addHandler(ch)

logger1.debug('logger1 debug message')
logger1.info('logger1 info message')
logger1.warning('logger1 warning message')
logger1.error('logger1 error message')
logger1.critical('logger1 critical message')

logger2.debug('logger2 debug message')
logger2.info('logger2 info message')
logger2.warning('logger2 warning message')
logger2.error('logger2 error message')
logger2.critical('logger2 critical message')

　　完整代码二：

#coding:utf-8
import logging  

# 创建一个logger
logger = logging.getLogger()  

logger1 = logging.getLogger('mylogger')
logger1.setLevel(logging.DEBUG)  

logger2 = logging.getLogger('mylogger')
logger2.setLevel(logging.INFO)  

logger3 = logging.getLogger('mylogger.child1')
logger3.setLevel(logging.WARNING)  

logger4 = logging.getLogger('mylogger.child1.child2')
logger4.setLevel(logging.DEBUG)  

logger5 = logging.getLogger('mylogger.child1.child2.child3')
logger5.setLevel(logging.DEBUG)  

# 创建一个handler，用于写入日志文件
fh = logging.FileHandler('/tmp/test.log')  

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

# 定义handler的输出格式formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)  

#定义一个filter
#filter = logging.Filter('mylogger.child1.child2')
#fh.addFilter(filter)    

# 给logger添加handler
#logger.addFilter(filter)
logger.addHandler(fh)
logger.addHandler(ch)  

#logger1.addFilter(filter)
logger1.addHandler(fh)
logger1.addHandler(ch)  

logger2.addHandler(fh)
logger2.addHandler(ch)  

#logger3.addFilter(filter)
logger3.addHandler(fh)
logger3.addHandler(ch)  

#logger4.addFilter(filter)
logger4.addHandler(fh)
logger4.addHandler(ch)  

logger5.addHandler(fh)
logger5.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')  

logger1.debug('logger1 debug message')
logger1.info('logger1 info message')
logger1.warning('logger1 warning message')
logger1.error('logger1 error message')
logger1.critical('logger1 critical message')  

logger2.debug('logger2 debug message')
logger2.info('logger2 info message')
logger2.warning('logger2 warning message')
logger2.error('logger2 error message')
logger2.critical('logger2 critical message')  

logger3.debug('logger3 debug message')
logger3.info('logger3 info message')
logger3.warning('logger3 warning message')
logger3.error('logger3 error message')
logger3.critical('logger3 critical message')  

logger4.debug('logger4 debug message')
logger4.info('logger4 info message')
logger4.warning('logger4 warning message')
logger4.error('logger4 error message')
logger4.critical('logger4 critical message')  

logger5.debug('logger5 debug message')
logger5.info('logger5 info message')
logger5.warning('logger5 warning message')
logger5.error('logger5 error message')
logger5.critical('logger5 critical message')

　　应用：

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

　　

他们之间的关系如下（图表示）：

三，应用实例及问题详解

3.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 ....")

　

3.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")

　　

3.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

　

3.4   logger.setLevel(logging.INFO)和ch.setLevel(logging.DEBUG)的区别：

首先创建一个logger，并把其写入文件和屏幕输出

import logging

#创建一个logging的实例logger
logger = logging.getLogger('Richard')
#设定全局变量为DEBUG
logger.setLevel(logging.INFO)
#创建一个屏幕的handler,并且设定级别为DEBUG
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
#创建一个日志文件的handler，并且设定级别为INFO
fh = logging.FileHandler("access.log")
fh.setLevel(logging.CRITICAL)
# 设置日志的格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# 把fh和ch添加到日志文件中
logger.addHandler(ch)
logger.addHandler(fh)
logger.debug("debug message")
logger.info("info message")
logger.warn("warn message")
logger.error("error message")
logger.critical("crititcal message")

　　屏幕输出为：

2018-03-16 10:32:35,373 - Richard - INFO - info message
2018-03-16 10:32:35,373 - Richard - WARNING - warn message
2018-03-16 10:32:35,373 - Richard - ERROR - error message
2018-03-16 10:32:35,373 - Richard - CRITICAL - crititcal message

　　文件输出为：

2018-03-16 10:32:35,373 - Richard - CRITICAL - crititcal message

　　在这里需要说明的一点是logger.setLevel(logging.INFO)和ch.setLevel(logging.DEBUG)的区别：

import logging

#创建一个logging的实例logger
logger = logging.getLogger('Richard')
#设定全局变量为CRITICAL
logger.setLevel(logging.CRITICAL)
#创建一个屏幕的handler,并且设定级别为DEBUG
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
#创建一个日志文件的handler，并且设定级别为INFO
fh = logging.FileHandler("access.log")
fh.setLevel(logging.INFO)
# 设置日志的格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# 把fh和ch添加到日志文件中
logger.addHandler(ch)
logger.addHandler(fh)
logger.debug("debug message")
logger.info("info message")
logger.warn("warn message")
logger.error("error message")
logger.critical("crititcal message")

　　屏幕输出：

2018-03-16 10:36:58,972 - Richard - CRITICAL - crititcal message

　　文件输出：

2018-03-16 10:36:58,972 - Richard - CRITICAL - crititcal message

　　

就是全局日志级别为CRITICAL的话，局部变量想设置成INFO或者DEBUG都会失效。

　　由此可以得出全局的比局部的级别要高，加入全局的设成DEBUG的话，局部可以设成WARNING，那么logging只会输出WARNG、ERROR、CRITICAL这三种类型。

logging&try-exception捕捉记录异常

常见的异常请参考博文：一篇搞定所有的异常处理

方法一：

import logging
import os
import sys

def get_logger():
    # 创建日志
    logger = logging.getLogger()
    # 创建文件对象，给文件对象设置等级
    logger.setLevel(logging.INFO)

    # 创建一个handler，用于写入日志文件
    file_handler = logging.FileHandler('test.log')
    # 设置日志级别
    file_handler.setLevel(logging.INFO)

    # 设置输出对象格式，日志格式器
    formatter = logging.Formatter('%(asctime)s -----%(message)s')
    # 把日志格式器添加到配置中
    file_handler.setFormatter(formatter)
    # 把日志打印到指定的handler
    logger.addHandler(file_handler)
    return logger

if __name__ == '__main__':
    logger = get_logger()
    try:
        print(1/0)
    except Exception as e:
        logger.exception(sys.exc_info())

　　

方法二：

import logging
import sys

def get_logger(logname):
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    LOG_PATH = 'model/'
    LogFile = LOG_PATH + logname + '.log'
    file_handler = logging.FileHandler(LogFile)
    file_handler.setLevel(logging.INFO)
    formatter = logging.Formatter("%(asctime)s ---------------%(message)s")
    file_handler.setFormatter(formatter)
    logger.addHandler(file_handler)
    return logger

if __name__ == '__main__':
    logname = 'test'
    logger = get_logger(logname)
    try:
        print(1/0)
        # raise ValueError('this is a exp')
    except Exception as e:
        # logger.info(e)
        logger.debug(e)

　

方法三：traceback模块

　　trackback模块被用来跟踪异常返回信息

　　举个例子：

import traceback  # 调用traceback模块
try:
    if str(123) > 5:
        print('这是一个无法执行的错误')
except Exception:
    traceback.print_exc()  # 返回错误信息

# 控制台输出结果：
# Traceback (most recent call last):
#   File "D:/pycharm/S9/pythontext/main.py", line 27, in <module>
#     if str(123) > 5:
# TypeError: '>' not supported between instances of 'str' and 'int'

　　此报错信息，我们写入文件中，如下：

   import traceback
    try:
        # print(1/0)
        raise ValueError('this is a exp')
    except Exception as e:
        # file打开或创建一个名为log.log的文件以追加形式填入报错
        # 文件内内容与上程序控制台输出的相同
        traceback.print_exc(file=open('model/log.log', mode='a', encoding='utf-8'))

　　结果如下：

　

logging模块练习题

1，logging模块有几个日志级别？

    总共有5个级别，默认级别是WARNING，
    按照级别高低分别为CRITICAL    ERROR    WARNING  INFO DEBUG

　　

2，请配置logging模块，使其在屏幕和文件里同时打印以下格式的日志

2017-10-18 15:56:26,613 - access - ERROR - account [1234] too many login attempts

　　

# 2，请配置logging模块，使其在屏幕和文件里同时打印以下格式的日志
# 2017-10-18 15:56:26,613 - access - ERROR - account [1234] too many login attempts
import logging

logger = logging.getLogger('mylog')
logger.level = logging.INFO

# 创建一个handler，用于写入日志文件
fh = logging.FileHandler('exer.log')
# 再创建一个handler，用于写入输出控制台
ch = logging.StreamHandler()
fh.level = logging.WARNING
ch.level = logging.ERROR

logger.addHandler(fh)
logger.addHandler(ch)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(lineno)s %(message)s')

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

logger.debug('too many login attempts')
logger.info('too many login attempts')
logger.warning('too many login attempts')
logger.error('too many login attempts')
logger.critical('too many login attempts')