Python logging模块

转自：https://www.cnblogs.com/zhbzz2007/p/5943685.html

日志回滚部分参考自：https://www.cnblogs.com/andy9468/p/8378492.html

Python标准模块--logging

1 logging模块简介

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

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

2 logging模块使用

2.1 基本使用

配置logging基本的设置，然后在控制台输出日志，

import logging
logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

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

运行时，控制台输出，

2016-10-09 19:11:19,434 - __main__ - INFO - Start print log
2016-10-09 19:11:19,434 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:11:19,434 - __main__ - INFO - Finish

logging中可以选择很多消息级别，如debug、info、warning、error以及critical。通过赋予logger或者handler不同的级别，开发者就可以只输出错误信息到特定的记录文件，或者在调试时只记录调试信息。

例如，我们将logger的级别改为DEBUG，再观察一下输出结果，

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

控制台输出，可以发现，输出了debug的信息。

2016-10-09 19:12:08,289 - __main__ - INFO - Start print log
2016-10-09 19:12:08,289 - __main__ - DEBUG - Do something
2016-10-09 19:12:08,289 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:12:08,289 - __main__ - INFO - Finish

logging.basicConfig函数各参数：

• filename：指定日志文件名；

• filemode：和file函数意义相同，指定日志文件的打开模式，'w'或者'a'；

• format：指定输出的格式和内容，format可以输出很多有用的信息，

%(levelno)s    ：打印日志级别的数值
%(levelname)s  ：打印日志级别的名称
%(pathname)s   ：打印当前执行程序的路径，其实就是sys.argv[0]
%(filename)s   ：打印当前执行程序名
%(funcName)s   ：打印日志的当前函数
%(lineno)d     ：打印日志的当前行号
%(asctime)s    ：打印日志的时间
%(thread)d     ：打印线程ID
%(threadName)s ：打印线程名称
%(process)d    ：打印进程ID
%(message)s    ：打印日志信息

• datefmt：指定时间格式，同time.strftime()；

• level：设置日志级别，默认为 logging.WARNNING

• stream：指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到 sys.stderr，当 stream 和 filename 同时指定时，stream被忽略；

2.2 将日志写入到文件

2.2.1 将日志写入到文件

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

import logging


# 获取 logger，设置级别
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 中
logger.addHandler(handler)


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

log.txt中日志数据为，

2016-10-09 19:01:13,263 - __main__ - INFO - Start print log
2016-10-09 19:01:13,263 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:01:13,263 - __main__ - INFO - Finish

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

logger中添加StreamHandler，可以将日志输出到屏幕上，

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)
# 一个流处理器，用来显示到屏幕
console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)


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

可以在log.txt文件和控制台中看到，

2016-10-09 19:20:46,553 - __main__ - INFO - Start print log
2016-10-09 19:20:46,553 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:20:46,553 - __main__ - INFO - Finish

可以发现，logging有一个日志处理的主对象，其他处理方式都是通过addHandler添加进去，logging中包含的handler主要有如下几种，

handler名称：位置；作用

StreamHandler      ：logging.StreamHandler；                日志输出到流，可以是sys.stderr，sys.stdout或者文件
FileHandler        ：logging.FileHandler；                  日志输出到文件
BaseRotatingHandler：logging.handlers.BaseRotatingHandler； 基本的日志回滚方式
RotatingHandler    ：logging.handlers.RotatingHandler；     日志回滚方式，支持日志文件最大数量和日志文件回滚
TimeRotatingHandler：logging.handlers.TimeRotatingHandler； 日志回滚方式，在一定时间区域内回滚日志文件
SocketHandler      ：logging.handlers.SocketHandler；       远程输出日志到TCP/IP sockets
DatagramHandler    ：logging.handlers.DatagramHandler；     远程输出日志到UDP sockets
SMTPHandler        ：logging.handlers.SMTPHandler；         远程输出日志到邮件地址
SysLogHandler      ：logging.handlers.SysLogHandler；       日志输出到syslog
NTEventLogHandler  ：logging.handlers.NTEventLogHandler；   远程输出日志到Windows NT/2000/XP的事件日志
MemoryHandler      ：logging.handlers.MemoryHandler；       日志输出到内存中的指定buffer
HTTPHandler        ：logging.handlers.HTTPHandler；         通过"GET"或者"POST"远程输出到HTTP服务器

2.2.3 日志回滚

什么是日志回滚？

答：

将日志信息输出到一个单一的文件中，随着应用程序的持续使用，该日志文件会越来越庞大，进而影响系统的性能。因此，有必要对日志文件按某种条件进行切分，要切分日志文件。

分割日志的触发条件：大小、日期，或者大小加上日期。

说是切分，实际上是，当一个日志文件达到触发条件后，对日志文件进行重命名，之后再新建原来名称的日志文件（此时就是空文件了），新产生的日志就写入新的日志文件。

为啥叫回滚呢？当分割的日志文件达到指定数目的上限个数时，最老的日志文件就会被删除。

使用 RotatingFileHandler，可以实现日志按照文件大小进行回滚

按照日志文件大小回滚：

import logging
from logging.handlers import RotatingFileHandler


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

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

#定义一个RotatingFileHandler，最多备份3个日志文件，每个日志文件最大1K
rHandler = RotatingFileHandler("log.txt", maxBytes = 1*1024, backupCount = 3)
rHandler.setLevel(logging.INFO)
rHandler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(rHandler)
logger.addHandler(console)


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

可以在工程目录中看到，备份的日志文件

2016/10/09  19:36               732 log.txt
2016/10/09  19:36               967 log.txt.1
2016/10/09  19:36               985 log.txt.2
2016/10/09  19:36               976 log.txt.3

按照天回滚日志：

import time
import logging
import logging.handlers
import os
 
# 如果日志文件夹不存在，则创建
log_dir = "log-day"  # 日志存放文件夹名称
log_path = os.getcwd() + os.sep + log_dir
if not os.path.isdir(log_path):
    os.makedirs(log_path)
 
# logging初始化工作
logging.basicConfig()
 
# 获取 logger 对象
myapp = logging.getLogger('myapp')
myapp.setLevel(logging.INFO)
 
# 添加TimedRotatingFileHandler
# 定义一个1天换一次log文件的handler
# 保留3个旧log文件
timefilehandler = logging.handlers.TimedRotatingFileHandler(
    log_dir + os.sep + "sec.log",
    when='D',
    interval=1,
    backupCount=3
)

# 设置后缀名称，跟strftime的格式一样
timefilehandler.suffix = "%Y-%m-%d_%H-%M-%S.log"

formatter = logging.Formatter('%(asctime)s|%(name)-12s: %(levelname)-8s %(message)s')
timefilehandler.setFormatter(formatter)
myapp.addHandler(timefilehandler)
 
while True:
    time.sleep(6)
    myapp.info("test")

TimedRotatingFileHandler 的构造函数定义如下:
TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])

• filename 是输出日志文件名的前缀，比如log/myapp.log
• when 是一个字符串的定义如下：
  “S”: Seconds
  “M”: Minutes
  “H”: Hours
  “D”: Days
  “W”: Week day (0=Monday)
  “midnight”: Roll over at midnight
• interval 是指等待多少个单位when的时间后，Logger会自动重建文件，当然，这个文件的创建
  取决于filename+suffix，若这个文件跟之前的文件有重名，则会自动覆盖掉以前的文件，所以
  有些情况suffix要定义的不能因为when而重复。
• backupCount 是保留日志个数。默认的0是不会自动删除掉日志。若设3，则在文件的创建过程中
  库会判断是否有超过这个3，若超过，则会从最先创建的开始删除。

2.3 设置消息的等级

可以设置不同的日志等级，用于控制日志的输出，

FATAL   ：致命错误
CRITICAL：特别糟糕的事情，如内存耗尽、磁盘空间为空，一般很少使用
ERROR   ：发生错误时，如IO操作失败或者连接问题
WARNING ：发生很重要的事件，但是并不是错误时，如用户登录密码错误
INFO    ：处理请求或者状态变化等日常事务
DEBUG   ：调试过程中使用DEBUG等级，如算法中每个循环的中间状态

2.4 捕获traceback

Python中的traceback模块被用于跟踪异常返回信息，可以在logging中记录下traceback，

代码:

import logging


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

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

handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)


logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
try:
    open("sklearn.txt","rb")
except (SystemExit,KeyboardInterrupt):
    raise
except Exception:
    logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)  # 这儿多一个参数：exc_info

logger.info("Finish")

控制台和日志文件log.txt中输出:

Start print log
Something maybe fail.
Faild to open sklearn.txt from logger.error
Traceback (most recent call last):
  File "G:\zhb7627\Code\Eclipse WorkSpace\PythonTest\test.py", line 23, in <module>
    open("sklearn.txt","rb")
IOError: [Errno 2] No such file or directory: 'sklearn.txt'
Finish

也可以使用logger.exception(msg,_args)，它等价于logger.error(msg,exc_info = True,_args)，

将

logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

替换为，

logger.exception("Failed to open sklearn.txt from logger.exception")

控制台和日志文件log.txt中输出，

Start print log
Something maybe fail.
Failed to open sklearn.txt from logger.exception
Traceback (most recent call last):
  File "G:\zhb7627\Code\Eclipse WorkSpace\PythonTest\test.py", line 23, in <module>
    open("sklearn.txt","rb")
IOError: [Errno 2] No such file or directory: 'sklearn.txt'
Finish

2.5 多模块使用logging

主模块mainModule.py，

import logging
import subModule

# 在主模块中，生成一个主 logger
logger = logging.getLogger("mainModule")
logger.setLevel(level = logging.INFO)

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

handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)


logger.info("creating an instance of subModule.subModuleClass")
a = subModule.SubModuleClass()  # 子模块的方法
logger.info("calling subModule.subModuleClass.doSomething")
a.doSomething()
logger.info("done with  subModule.subModuleClass.doSomething")
logger.info("calling subModule.some_function")
subModule.som_function()
logger.info("done with subModule.some_function")

子模块subModule.py，

import logging


# 生成一个 mainModule 的子 logger
module_logger = logging.getLogger("mainModule.sub")


class SubModuleClass(object):
    def __init__(self):
        self.logger = logging.getLogger("mainModule.sub.module")
        self.logger.info("creating an instance in SubModuleClass")
    def doSomething(self):
        self.logger.info("do something in SubModule")
        a = []
        a.append(1)
        self.logger.debug("list a = " + str(a))
        self.logger.info("finish something in SubModuleClass")


def som_function():
    module_logger.info("call function some_function")

执行之后，在控制和日志文件log.txt中输出，

2016-10-09 20:25:42,276 - mainModule - INFO - creating an instance of subModule.subModuleClass
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - creating an instance in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - do something in SubModule
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - finish something in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - done with  subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.some_function
2016-10-09 20:25:42,279 - mainModule.sub - INFO - call function some_function
2016-10-09 20:25:42,279 - mainModule - INFO - done with subModule.some_function

首先在主模块定义了logger'mainModule，并对它进行了配置，就可以在解释器进程里面的其他地方通过 getLogger('mainModule') 来得到这个对象。定义的该 logger 的子 logger，都可以共享父 logger 的定义和配置，所谓的父子 logger 是通过命名来识别，任意以 mainModule 开头的 logger 都是它的子 logger，例如 mainModule.sub

3 通过JSON或者YAML文件配置logging模块

尽管可以在Python代码中配置logging，但是这样并不够灵活，最好的方法是使用一个配置文件来配置。在Python 2.7及以后的版本中，可以从字典中加载logging配置，也就意味着可以通过JSON或者YAML文件加载日志的配置。

3.1 通过JSON文件配置

logging 可以将配置写成 json 格式，它的主要格式如下：

{
    "version":1,
    "disable_existing_loggers":false,
    "formatters":{
    },
    "filters": {
    	},
    "handlers":{
    },
    "loggers":{
    },
    "root":{
    }
}

上面格式中，每个键都是一个关键字。

必须包含的键：

• version : 目前唯一有效值是 1

其他键都是可选的：

• formatters：用来定义所有的格式器，它的键是自定义格式器的名字，值是格式器的属性：format, datefmt, style, class(实例化格式器的类名)

    "formatters":{
        "simple":{
            "format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s",
            "datefmt": "%Y-%m-%d %H:%M:%S",
        }
    },

上面定义了一个名为 simple 的格式化器，定义了格式化器的 format 和 datefmt 属性 。你可以定义多个格式化器。

• filters: 定义所有的过滤器，它的键是自定义过滤器的名字，值的键默认是空字符串，值的值是过滤器

    "filters": {
        "filter1": {
            "": "ext://filter"
        }
    },

上面我们定义了一个名为 filter1 的过滤器。 过滤器的键默认是空字符串， 过滤器的值是过滤器对象。 ext:// 前缀代表了后面的 filter 是一个外部对象，它的本质是我们定义的一个名为 filter 的函数，因此我们使用 ext:// 来引用这个外部的函数，见后面的实例部分。

• handlers：定义所有的处理器，它的键是处理器名，值是处理器的配置字典。

    "handlers":{
        "console":{
            "class":"logging.StreamHandler",
            "level":"DEBUG",
            "formatter":"simple",
            "stream":"ext://sys.stdout"
        },
        "info_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"INFO",
            "formatter":"simple",
            "filename":"info.log",
            "filters": ["filter1"],
            "maxBytes":1024,
            "backupCount":20,
            "encoding":"utf8"
        },
        "error_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"ERROR",
            "formatter":"simple",
            "filename":"errors.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        }
    },

上面我们定义了三个处理器， 因为我们的配置是一个 json 文件，所以 class 键对应的值是字符串类型的类名。如果你的配置写成了 python 中的字典，则写成类名就行，不用加引号

处理器中可以添加过滤器，譬如 info_file_handler 处理器就添加了一个 filters 键值对，它是一个列表，可以添加多个过滤器。

• loggers：配置所有的logger对象，键是 logger 名字，值是 logger 的配置属性

    "loggers":{
        "my_module":{
            "level":"ERROR",
            "handlers":["info_file_handler"],
            "propagate":false
        }
    },

上面定义了一个日志记录器：my_module ， 我们可以给它添加处理器： handlers 是一个列表，用来配置当前 logger 使用的处理器。

• root：根日志记录器的配置。

    "root":{
        "level":"INFO",
        "handlers":["console","info_file_handler","error_file_handler"]
    }

实例：

config.json

{
    "version":1,
    "disable_existing_loggers":false,
    "formatters":{
        "simple":{
            "format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s",
            "datefmt": "%Y-%m-%d %H:%M:%S"
        }
    },
    "filters": {
        "filter1": {
            "": "ext://filter"
        }
    },
    "handlers":{
        "console":{
            "class":"logging.StreamHandler",
            "level":"DEBUG",
            "formatter":"simple",
            "stream":"ext://sys.stdout"
        },
        "info_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"INFO",
            "formatter":"simple",
            "filename":"info.log",
            "filters": ["filter1"],
            "maxBytes":1024,
            "backupCount":20,
            "encoding":"utf8"
        },
        "error_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"ERROR",
            "formatter":"simple",
            "filename":"errors.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        }
    },
    "loggers":{
        "my_module":{
            "level":"ERROR",
            "handlers":["info_file_handler"],
            "propagate":false
        }
    },
    "root":{
        "level":"INFO",
        "handlers":["console","info_file_handler","error_file_handler"]
    }
}

test.py

import json
import logging.config


# 这个过滤器，在 config.json 中这么用的： "ext://filter"
def filter(LogRecord):
	if LogRecord.levelname in ['ERROR', "CRITICAL"]:  # 如果级别不是 error,critical,就过滤掉
		return True
	return False


def setup_logging(default_path):
	path = default_path
	with open(path, "r") as f:
		config = json.load(f)
		logging.config.dictConfig(config)


def func():
	logger = logging.getLogger("my_module")  # 获取我们配置中的 my_module 日志记录器
	logger.info("This is info")
	logger.critical("This is critical")


if __name__ == "__main__":
	setup_logging(default_path="config.json")
	func()

3.2 通过YAML文件配置

通过YAML文件进行配置，比JSON看起来更加简介明了，

version: 1
disable_existing_loggers: False
formatters:
        simple:
            format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
handlers:
    console:
            class: logging.StreamHandler
            level: DEBUG
            formatter: simple
            stream: ext://sys.stdout
    info_file_handler:
            class: logging.handlers.RotatingFileHandler
            level: INFO
            formatter: simple
            filename: info.log
            maxBytes: 10485760
            backupCount: 20
            encoding: utf8
    error_file_handler:
            class: logging.handlers.RotatingFileHandler
            level: ERROR
            formatter: simple
            filename: errors.log
            maxBytes: 10485760
            backupCount: 20
            encoding: utf8
loggers:
    my_module:
            level: ERROR
            handlers: [info_file_handler]
            propagate: no
root:
    level: INFO
    handlers: [console,info_file_handler,error_file_handler]

通过YAML加载配置文件，然后通过logging.dictConfig配置logging，

import yaml
import logging.config
import os

def setup_logging(default_path = "logging.yaml",default_level = logging.INFO,env_key = "LOG_CFG"):
    path = default_path
    value = os.getenv(env_key,None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path,"r") as f:
            config = yaml.load(f)
            logging.config.dictConfig(config)
    else:
        logging.basicConfig(level = default_level)

def func():
    logging.info("start func")

    logging.info("exec func")

    logging.info("end func")

if __name__ == "__main__":
    setup_logging(default_path = "logging.yaml")
    func()
    

4 Reference

每个 Python 程序员都要知道的日志实践

Python标准模块logging

python 的日志logging模块学习