Python全栈之路----常用模块----logging模块

很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误、警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，logging的日志可以分为 debug()调试, info()记录, warning()有潜在问题, error()出问题 and critical()严重问题5个级别，下面我们看一下怎么用。

最简单用法

import logging

logging.warning("user [alex] attempted wrong password more than 3 times") #用户 alex 输错密码超过三次

logging.critical("server is down")  #服务器坏了

输出

WARNING:root:user [alex] attempted wrong password more than 3 times

CRITICAL:root:server is down

输出到文件

import logging

logging.basicConfig(filename='log_test',level=logging.INFO) #只添加比level中级别更高的，多次添加会追加

logging.debug('The message should go to the log file.')

logging.info('So shoule this')

logging.warning('And this, too.')

自定义日志格式

import logging

#加上格式、时间

logging.basicConfig(filename='log_test',

                    level=logging.DEBUG,

                    format='%(asctime)s %(message)s',

                    datefmt='%m/%d/%Y %I:%M:%S %p') 

logging.debug('The message should go to the log file.')

logging.info('So shoule this')

logging.warning('And this, too.')

除了加时间，还可以自定义一大堆格式，下表就是所有支持的格式，以下面的程序为例

import logging

logging.basicConfig(filename='log_test.log',

                    level=logging.DEBUG,

                    format='%(asctime)s %(message)s ', #此处可将下表中的format进行添加

                    datefmt='%m/%d/%Y %I:%M:%S %p')

def sayhi():

    logging.error('I am a error from sayhi.')

sayhi()

logging.debug('I am debug.')

logging.info('I am info.')

logging.warning('I am warning.')

logging.error('I am error.')

format	function	output
%(name)s	logger 的名字	root
%(levelno)s	数字形式的日志级别	10 #debug 20 #info 30 #warning 40 #error 50 #critical
%(levelname)s	文本形式的日志级别	DEBUG INFO WARNING ERROR
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有	D:/ProgramLearning/Py_program/module/logging_test.py
%(filename)s	调用日志输出函数的模块的文件名	logging_test.py
%(module)s	调用日志输出函数的模块名	logging_test
%(funcName)s	调用日志输出函数的函数名	sayhi #有函数的输出函数名 <module> #没有函数的输出 <module>
%(lineno)d	调用日志输出函数的语句所在的代码行	10 #函数中print的所在行，不是调用行 16
%(created)f	当前时间，用UNIX标准的表示时间的浮点数表示	1552807539.257233
%(relativeCreated)d	输出日志信息时的，自Logger创建以来的毫秒数	1
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒	03/17/2019 03:13:48
%(thread)d	线程ID。可能没有	2524
%(threadName)s	线程名。可能没有	MainThread
%(process)d	进程ID。可能没有	12656 #和subprocess模块里的pid作用一致
%(message)s	用户输出的消息	...I am a error from sayhi. ...I am debug. ...I am info. ...I am warning. ...I am error.

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

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

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

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

他们之间的关系如下：

logger.debug('test....')
logger.info('test info...')
logger.warning('network attack is coming...')
logger.error('test error...')

每个组件的主要功能

logger

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

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

而核心模块可以这样：

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

还可以绑定handler和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 类似于上面的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 这个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上

综合使用例子

import logging

#1.生成 logger 对象，不设置级别的情况下，默认level=warning

logger = logging.getLogger('web')

logger.setLevel(logging.INFO)

#2.生成 handler 对象

ch = logging.StreamHandler()

ch.setLevel(logging.DEBUG)

fh = logging.FileHandler('web.log') #输出到文件 web.log

fh.setLevel(logging.WARNING)

#2.1 把 handler 对象绑定到 logger

logger.addHandler(ch)

logger.addHandler(fh)

#3.生成 formatter 对象

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

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

#3.1 把 formatter 对象绑定 handler 对象

ch.setFormatter(file_formatter)

ch.setFormatter(console_formatter)

logger.debug('test log')

logger.error('test log 2')

#console: DEBUG

#global: INFO  default level: WARNING

#file: WARNING

#日志输入后，送到 global，global 过滤后送到 FileHandler 和 StreamHandler

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的完成例子

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

文件自动截断例子

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