pythonlogging_Python-logging-使用

功能介绍

日志的目的：

+ 诊断日志 记录与应用程序操作相关的日志。例如，用户遇到的报错信息， 可通过搜索诊断日志获得上下文信息。

+ 审计日志 为商业分析而记录的日志。从审计日志中，可提取用户的交易信息， 并结合其他用户资料构成用户报告或者用来优化商业目标。

Logging 能做什么？

+ 可以输出到控制台

+ 可以写入日志文档

基本使用–控制台输出日志

默认情况下，logging 输出到控制台。

import logging

logging.debug('debug message')

logging.info('info message')

logging.warn('warn message')

logging.error('error message')

logging.critical('critical message')

输出：WARNING:root:warn message

ERROR:root:error message

CRITICAL:root:critical message

Question：

为什么’debug message’ 和’info message’ 没有被输出？

Answer：

Logging 默认的日志等级为WARNING，只有日志级别高于WARNING 的日志才会被显示。关于日志级别，请继续往下看。

基本使用–写入日志文档

import logging

'''通过下面的方式进行简单配置输出方式与日志级别, level 设置日志级别，高于日志级别的就显示'''

logging.basicConfig(filename='logger.log', level=logging.INFO)

logging.debug('debug message')

logging.info('info message')

logging.warn('warn message')

logging.error('error message')

logging.critical('critical message')

basicConfig关键字参数：BasicConfig 关键字参数

基本概念

Logger 记录器： 这是我们能对整个对Logging 进行操作的对象。要输出Logging 一定要一个Logger，当然导入logging 之后有一个默认logging 为root logger。默认属性上面做了介绍。创建方法： logger = logging.getLogger(logger_name)Handler 处理器：Logger 中的属性。设置输出到控制台还是输出日志文档。Handler处理器类型有很多种，比较常用的有三个，StreamHandler，FileHandler，NullHandler。StreamHandler：输出到控制台创建方法: sh = logging.StreamHandler(stream=None)FileHandler： 输出到日志文档创建方法: fh = logging.FileHandler(filename, mode=’a’, encoding=None, delay=False)NullHandler： 什么都不做”的handler，由库开发者使用。

Filter 过滤器：logging 属性，可以决定输出哪些日志记录。创建方法: filter = logging.Filter(name=’’)Formatter 格式化器：logging 的属性，设置输出显示成什么样子。创建方法: formatter = logging.Formatter(fmt=None, datefmt=None)

format格式：Format 格式

dateformat设置参考： time.strftime

说明：Logger可以包含一个或多个Handler和Filter，即Logger与Handler或Fitler是一对多的关系;

一个Logger实例可以新增多个Handler，一个Handler可以新增多个格式化器或多个过滤器，而且日志级别将会继承。

配置实例：

import logging

# create logger

logger_name = "example"

logger = logging.getLogger(logger_name)

logger.setLevel(logging.DEBUG)

# create file handler

log_path = "./log.log"

fh = logging.FileHandler(log_path)

fh.setLevel(logging.WARN)

# create formatter

fmt = "%(asctime)-15s%(levelname)s%(filename)s%(lineno)d%(process)d%(message)s"

datefmt = "%a%d%b %Y %H:%M:%S"

formatter = logging.Formatter(fmt, datefmt)

# add handler and formatter to logger

fh.setFormatter(formatter)

logger.addHandler(fh)

# print log info

logger.debug('debug message')

logger.info('info message')

logger.warn('warn message')

logger.error('error message')

logger.critical('critical message')

执行架构

判断日志的等级是否大于Logger对象的等级，如果大于，则往下执行，否则，流程结束。

产生日志。第一步，判断是否有异常，如果有，则添加异常信息。第二步，处理日志记录方法(如debug，info等)中的占位符，即一般的字符串格式化处理。

使用注册到Logger对象中的Filters进行过滤。如果有多个过滤器，则依次过滤；只要有一个过滤器返回假，则过滤结束，且该日志信息将丢弃，不再处理，而处理流程也至此结束。否则，处理流程往下执行。

在当前Logger对象中查找Handlers，如果找不到任何Handler，则往上到该Logger对象的父Logger中查找；如果找到一个或多个Handler，则依次用Handler来处理日志信息。但在每个Handler处理日志信息过程中，会首先判断日志信息的等级是否大于该Handler的等级，如果大于，则往下执行(由Logger对象进入Handler对象中)，否则，处理流程结束。

执行Handler对象中的filter方法，该方法会依次执行注册到该Handler对象中的Filter。如果有一个Filter判断该日志信息为假，则此后的所有Filter都不再执行，而直接将该日志信息丢弃，处理流程结束。

使用Formatter类格式化最终的输出结果。 注：Formatter同上述第2步的字符串格式化不同，它会添加额外的信息，比如日志产生的时间，产生日志的源代码所在的源文件的路径等等。

真正地输出日志信息(到网络，文件，终端，邮件等)。至于输出到哪个目的地，由Handler的种类来决定。

高级使用

现在来归纳一下所有的日志配置方法：

缺省使用不配置

通过简单方式进行配置，使用basicConfig()函数直接进行配置；

显式创建记录器Logger、处理器Handler和格式化器Formatter，并进行相关设置；

通过配置文件进行配置，使用fileConfig()函数读取配置文件；

通过配置字典进行配置，使用dictConfig()函数读取配置信息；

通过网络进行配置，使用listen()函数进行网络配置。

使用配置文件.ini 进行配置：

1. 首先建立一个ini 文件logging_config.ini：

[loggers]

keys=root

[handlers]

keys=stream_handler

[formatters]

keys=formatter

[logger_root]

level=DEBUG

handlers=stream_handler

[handler_stream_handler]

class=StreamHandler

level=DEBUG

formatter=formatter

args=(sys.stderr,)

[formatter_formatter]

format=%(asctime)s %(name)-12s %(levelname)-8s %(message)s

然后在源码中调用 logging.config.fileConfig() 方法：

import logging

from logging.config import fileConfig

fileConfig('logging_config.ini')

logger = logging.getLogger()

logger.debug('often makes a very good meal of%s', 'visiting tourists')

通过字典进行配置的例子：

import logging

from logging.config import dictConfig

logging_config = dict(

version = 1,

formatters = {

'f': {'format':

'%(asctime)s%(name)-12s%(levelname)-8s%(message)s'}

},

handlers = {

'h': {'class': 'logging.StreamHandler',

'formatter': 'f',

'level': logging.DEBUG}

},

root = {

'handlers': ['h'],

'level': logging.DEBUG,

},

)

dictConfig(logging_config)

logger = logging.getLogger()

logger.debug('often makes a very good meal of%s', 'visiting tourists')