日志(log)
1. 日志的相关概念
日志的级别(level)
- DEBUG 调试
- INFO 信息
- NOTICE 注意
- WARNING 警告
- ERROR 错误
- CRITICAL 危险
- ALERT 警报
- EMERGENCY 紧急
注意:IO(输入输出)操作=>不要频繁操作
日志的作用
- 调试
- 了解软件的运行情况
- 分析定位问题
日志信息
- time(出错时间)
- 地点(那个函数)
- level(错误级别)
- 内容(出了什么错误)
成熟的第三方日志
- log4g(java)
- log4php(php)
- logging(Python)
2. Logging模块
日记的级别
- 级别可自定义
- DEBUG
- INFO
- WARNING
- ERROR
- CRITICAL
初始化/写日志实例需要制定级别,只有当级别等于或高于制定级别才被记录
使用方式
- 直接使用logging(封装了其他组件)
- logging四大组件直接定制
2.1 logging模块级别的日志
使用logging函数
msg:日志内容
- logging.debug(msg,*args,**kwargs) 创建一条严重级别为DEBUG的日志记录
- logging.info(msg,*args,**kwargs) 创建一条严重级别为INFO的日志记录
- logging.warning(msg,*args,**kwargs) 创建一条严重级别为WARNING的日志记录
- logging.error(msg,*args,**kwargs) 创建一条严重级别为ERROR的日志记录
- logging.critical(msg,*args,**kwargs) 创建一条严重级别为CRITICALG的日志记录
- logging.log(level,*args,**kwargs) 创建一条严重级别为level的日志记录
- logging.basicConfig(**kwargs) 对root logger进行一次性配置
logging.basicConfig(**kwargs) 对root logger进行一次性配置 (注意:只在第一次调用的时候起作用)
logger默认值
- 输出:sys.stderr
- 级别:WARNING
- 格式:level:log_name:content
logger配置实例
默认从WARNING级别开始
代码:
import logging
logging.debug("This is a debug log.")
logging.info("This is a info log.")
logging.warning("This is a warning log.")
logging.error("This is a error log.")
logging.critical("This is a critical log.")
输出:
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.
用logging.basicConfig()来更改默认值
1.
代码:
import logging
logging.basicConfig(level=logging.DEBUG)
#level 级别
#filename 存储文件名(一般后缀名为:<<.log>>)
#format 格式
logging.debug("This is a debug log.")
logging.info("This is a info log.")
logging.warning("This is a warning log.")
logging.error("This is a error log.")
logging.critical("This is a critical log.")
输出:
DEBUG:root:This is a debug log.
INFO:root:This is a info log.
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.
2.
代码:
import logging
LOG_FORMAT = "%(asctime)s====%(levelname)s====%(message)s"
#不要忘记写百分号和s
logging.basicConfig(level=logging.DEBUG,format=LOG_FORMAT)
#level 级别
#filename 存储文件名(一般后缀名为:<<.log>>)
#format 格式
logging.debug("This is a debug log.")
logging.info("This is a info log.")
logging.warning("This is a warning log.")
logging.error("This is a error log.")
logging.critical("This is a critical log.")
输出:
2019-01-11 16:59:02,537====DEBUG====This is a debug log.
2019-01-11 16:59:02,537====INFO====This is a info log.
2019-01-11 16:59:02,537====WARNING====This is a warning log.
2019-01-11 16:59:02,538====ERROR====This is a error log.
2019-01-11 16:59:02,538====CRITICAL====This is a critical log.
2.1 logging模块的处理流程
四大组件
- 日志器(Logger):产生日志器的接口
- 处理器(Handler):把生产的日志发送到相应目的地
- 过滤器(Filter):更精细的控制那些日志输出
- 格式器(Formatter):对输出信息进行格式化
Logger
- 产生一个日志
- 操作
Logger.setLevel() 设置日志器将会处理的日志信息的最低严重级别
Logger.addHandler() 和 logger.removeHandler() 为该logger对象添加 和 移除一个处理器 Logger.addFilter() 和 logger.removeFilter() 为该logger对象添加 和 移除一个过滤器
Logger.debug 产生一条debug级别的日志,同理,info,error,等
Logger.exception() 创建类似与Logger.error的日志信息 Logger.log() 获取一个明确的日志level参数创建一个日志记录
如何得到一个logger对象
- 实例化
- logging.getLogger()
Handler
- 把log发送到指定位置
- 方法
setLevel
setFormat
addFilter,removeFilter
- 不需要直接使用。Handler是基类( 基类是给人继承的)
logging.StreamHandler 将日志消息发送到输出到Stream,如std.out,std.err或任何file-like对象
logging.FileHandler 将日志消息发送到磁盘文件,默认情况下默认情况下文件大小会无限增大
logging.handlers.RotatingFileHandler 将日志消息发送到磁盘文件,并支持日志文件按大小切割
logging.handlers.HTTPHandler 将日志消息以GET或POST的方式发送给一个HTTP服务器
logging.handlers.SMTPHandler 将日志消息发送给一个制定的email地址
logging.NullHandler 该Handler实例会忽略error messages,通常被使用logging的library开发者使用
Format类
- 直接实例化
- 可以继承Format添加特殊内容
- 三个参数
fmt: 指定消息格式化字符串,如果不指定参数则默认使用message的原始值
datefmt:指定日期格式字符串,如果不指定参数则默认使用"%Y-%m-%d %H:%M:%S"
style:Python 3.2新增的参数,可取值'%','{'和'$',如果不指定该参数则默认使用'%'
Filter类
- 可以被Handler和logger使用
- 控制传递过来的信息的具体内容
logging.handlers.TimedRotatingFileHandler
TimedRotatingFileHandler这个模块是满足文件名按时间自动更换的需求,这样就可以保证日志单个文件不会太大。
用法很简单,示例代码:
import logging
import logging.handlers
# logging初始化工作
logging.basicConfig()
# nor的初始化工作
nor = logging.getLogger("nor")
nor.setLevel(logging.INFO)
# 添加TimedRotatingFileHandler到nor
# 定义一个1分钟换一次log文件的handler
filehandler = logging.handlers.TimedRotatingFileHandler(
"logging_test2", 'M', 1, 0)
# 设置后缀名称,跟strftime的格式一样
filehandler.suffix = "%Y%m%d-%H%M.log"
nor.addHandler(filehandler)
TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])
filename 是输出日志文件名的前缀
when 是一个字符串的定义如下:
“S”: Seconds
“M”: Minutes
“H”: Hours
“D”: Days
“W”: Week day (0=Monday)
“midnight”: Roll over at midnight(在0点)
interval 是指等待多少个单位when的时间后,Logger会自动重建文件,当然,这个文件的创建
取决于filename+suffix,若这个文件跟之前的文件有重名,则会自动覆盖掉以前的文件,所以
有些情况suffix要定义的不能因为when而重复。
backupCount 是保留日志个数。默认的0是不会自动删除掉日志。若设10,则在文件的创建过程中
库会判断是否有超过这个10,若超过,则会从最先创建的开始删除。
3. 实例
需求
- 要求将所有级别的日志都写入磁盘文件中
- all.log文件中记录所有的日志信息,日志格式为:日期和时间 - 日志级别 - 日志信息
- error.log文件中单独记录error级以上级别的日志信息,日志格式为:日期和时间 - 日志级别 - 文件名[:行号] - 日志信息
- 要求all.log在每天凌晨进行日志切割
分析
- 要记录所有级别的日志,因此日志器的有效level需要设置为最低级别--DEBUG;
- 日志需要被发送到两个不同的目的地,因此需要为日志器设置两个handler;另外,两个目的地都是磁盘文件,因此这两个handler都是与FileHandler相关的;
- all.log要求按照时间进行日志切割,因此他需要用logging.handlers.TimedRotatingFileHandler; 而error.log没有要求日志切割,因此可以使用FileHandler;
- 两个日志文件的格式不同,因此需要对这两个handler分别设置格式器;
import logging
import logging.handlers
import datetime
logger = logging.getLogger("mylogger")
logger.setLevel(logging.DEBUG) # 设置最低级别的 DeBUG'
rf_handler = logging.handlers.TimedRotatingFileHandler("all.log", when="midnight", interval=1, backupCount=7, atTime= datetime.time(0, 0, 0, 0))
rf_handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")) # 设置格式
f_handler = logging.FileHandler("error.log", encoding="utf-8") # 写入日志文件
f_handler.setLevel(logging.ERROR) # 设置日志等级
f_handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s")) # 设置信息格式
logger.addHandler(rf_handler) # 添加处理器 rf_handler
logger.addHandler(f_handler) # 添加处理器 f_handler
logger.debug("This is a debug log.")
logger.info("This is a info log.")
logger.warning("This is a warning log.")
logger.error("This is a error log.")
logger.critical("This is a critical log.")