logging 日志模块详解

用Python写代码的时候，在想看的地方写个print xx 就能在控制台上显示打印信息，这样子就能知道它是什么了，但是当我需要看大量的地方或者在一个文件中查看的时候，这时候print就不大方便了，所以Python引入了logging模块来记录我想要的信息。

print也可以输入日志，logging相对print来说更好控制输出在哪个地方，怎么输出及控制消息级别来过滤掉那些不需要的信息。

1、日志级别

默认生成的root logger的level是logging.WARNING,低于该级别的就不输出了

级别排序:CRITICAL > ERROR > WARNING > INFO > DEBUG

debug : 打印全部的日志,详细的信息,通常只出现在诊断问题上

info : 打印info,warning,error,critical级别的日志,确认一切按预期运行

warning : 打印warning,error,critical级别的日志,一个迹象表明,一些意想不到的事情发生了,或表明一些问题在不久的将来(例如。磁盘空间低”),这个软件还能按预期工作

error : 打印error,critical级别的日志,更严重的问题,软件没能执行一些功能

critical : 打印critical级别,一个严重的错误,这表明程序本身可能无法继续运行

这时候，如果需要显示低于WARNING级别的内容，可以引入NOTSET级别来显示：

import logging# 引入logging模块

logging.basicConfig(level=logging.NOTSET)# 设置日志级别

logging.debug(u"如果设置了日志级别为NOTSET,那么这里可以采取debug、info的级别的内容,也可以显示在控制台上了")

2、部分名词解释

Logging.Formatter：这个类配置了日志的格式，在里面自定义设置日期和时间，输出日志的时候将会按照设置的格式显示内容。

Logging.Logger：Logger是Logging模块的主体，进行以下三项工作：

1. 为程序提供记录日志的接口

2. 判断日志所处级别，并判断是否要过滤

3. 根据其日志级别将该条日志分发给不同handler

常用函数有：

Logger.setLevel() 设置日志级别

Logger.addHandler() 和 Logger.removeHandler() 添加和删除一个Handler

Logger.addFilter() 添加一个Filter,过滤作用

Logging.Handler：Handler基于日志级别对日志进行分发，如设置为WARNING级别的Handler只会处理WARNING及以上级别的日志。

常用函数有：

setLevel() 设置级别

setFormatter() 设置Formatter

3.参数详解

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

filename：用指定的文件名创建FiledHandler，这样日志会被存储在指定的文件中。

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用户输出的消息

参数详解

4.logger对象配置

logging库提供了多个组件：Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口，Handler发送日志到适当的目的地，Filter提供了过滤日志信息的方法，Formatter指定日志显示格式。另外，可以通过：logger.setLevel(logging.Debug)设置级别,当然，也可以通过fh.setLevel(logging.Debug)单对文件流设置某个级别。

importlogging

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

fh = logging.FileHandler('test.log',encoding='utf-8')#再创建一个handler，用于输出到控制台

ch =logging.StreamHandler()

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

fh.setLevel(logging.DEBUG)

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

对象配置

5.logger的配置文件

通过logger的对象配置去完成日志的功能 这种方式需要创建各种对象，比如logger对象，fileHandler对象，ScreamHandler对象等等，比较麻烦，现在提供一种字典的方式，创建logger配置文件，这种才是工作中经常使用的实现日志功能的方法，真正的做到   ----- 拿来即用(简单改改)。

"""logging配置"""

importosimportlogging.config#定义三种日志输出格式 开始

standard_format= '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'\'[%(levelname)s][%(message)s]' #其中name为getlogger指定的名字

simple_format= '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'id_simple_format= '[%(levelname)s][%(asctime)s] %(message)s'

#定义日志输出格式 结束

logfile_dir= os.path.dirname(os.path.abspath(__file__)) #log文件的目录

logfile_name= 'all2.log' #log文件名

#如果不存在定义的日志目录就创建一个

if notos.path.isdir(logfile_dir):

os.mkdir(logfile_dir)#log文件的全路径

logfile_path =os.path.join(logfile_dir, logfile_name)#log配置字典

LOGGING_DIC ={'version': 1,'disable_existing_loggers': False,'formatters': {'standard': {'format': standard_format

},'simple': {'format': simple_format

},

},'filters': {},'handlers': {#打印到终端的日志

'console': {'level': 'DEBUG','class': 'logging.StreamHandler', #打印到屏幕

'formatter': 'simple'},#打印到文件的日志,收集info及以上的日志

'default': {'level': 'DEBUG','class': 'logging.handlers.RotatingFileHandler', #保存到文件

'formatter': 'standard','filename': logfile_path, #日志文件

'maxBytes': 1024*1024*5, #日志大小 5M

'backupCount': 5,'encoding': 'utf-8', #日志文件的编码，再也不用担心中文log乱码了

},

},'loggers': {#logging.getLogger(__name__)拿到的logger配置

'': {'handlers': ['default', 'console'], #这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕

'level': 'DEBUG','propagate': True, #向上(更高level的logger)传递

},

},

}defload_my_logging_cfg():

logging.config.dictConfig(LOGGING_DIC)#导入上面定义的logging配置

logger = logging.getLogger(__name__) #生成一个log实例

logger.info('It works!') #记录该文件的运行状态

if __name__ == '__main__':

load_my_logging_cfg()

logger配置文件

#注意：

#1、有了上述方式我们的好处是：所有与logging模块有关的配置都写到字典中就可以了，更加清晰，方便管理

#2、我们需要解决的问题是：

1、从字典加载配置：logging.config.dictConfig(settings.LOGGING_DIC)2、拿到logger对象来产生日志

logger对象都是配置到字典的loggers 键对应的子字典中的

按照我们对logging模块的理解，要想获取某个东西都是通过名字，也就是key来获取的

于是我们要获取不同的logger对象就是

logger=logging.getLogger('loggers子字典的key名')

但问题是：如果我们想要不同logger名的logger对象都共用一段配置，那么肯定不能在loggers子字典中定义n个key'loggers': {'l1': {'handlers': ['default', 'console'], # 'level': 'DEBUG','propagate': True, #向上(更高level的logger)传递

},'l2: {

'handlers': ['default', 'console'],'level': 'DEBUG','propagate': False, #向上(更高level的logger)传递

},'l3': {'handlers': ['default', 'console'], # 'level': 'DEBUG','propagate': True, #向上(更高level的logger)传递

},

}#我们的解决方式是，定义一个空的key

'loggers': {'': {'handlers': ['default', 'console'],'level': 'DEBUG','propagate': True,

},

}

这样我们再取logger对象时

logging.getLogger(__name__)，不同的文件__name__不同，这保证了打印日志时标识信息不同，但是拿着该名字去loggers里找key名时却发现找不到，于是默认使用key=''的配置

如何拿到logger对象的详细解释