最近想在python flask项目中使用日志功能,于是想到了python自带的日志模块logging. 在学习这个logging模块之前,我们先来了解四个比较重要的概念:Logger,Handler,Formatter,Filter.
Logger记录器:应用程序代码能直接使用的接口.
Handler处理器:将Logger记录器产生的的日志发送到指定的目的地.
Filter过滤器:可以有更好的粒度控制去决定输出哪些日志.
Formatter格式化器:决定输出的日志格式.
Logger记录器:
要使用logging模块来记录日志,首先要创建一个Logger记录器,如果没有显式的进行创建,则默认创建一个root logger,并且默认的日志级别为WARN和处理器Handler(StreamHandler,即将日志信息打印输出在标准输出).
创建Logger的方法:
logger = logging.getLogger(logger_name) #这个logger_name可以自己定义
创建了Logger实例之后,可以用以下方法对日志级别进行设置:
logger.setLevel(logging.ERROR) #日志级别为ERROR,大于或者等于ERROR级别的日志才会进行输出
为Logger实例增加一个处理器:
logger.addHandler(handler_name) #handler_name可以自定定义
为Logger实例移除一个处理器:
logger.removeHandler(handler_name)
Handler处理器:
比较常用的处理器有三种:StreamHandler、FileHandler、NullHandler
StreamHandler,即将日志信息打印输出在标准输出
创建一个StreamHandler:sh = logging.StreamHandler(stream=None)
FileHandler,即将日志信息打印输出到文件
创建一个FileHandler:fh = logging.FileHandler(filename,mode='a')
NullHandler,不做任何的格式化输出,本质上它是一个“什么都不做”的Handler.
Formatter格式化器:
使用Formatter格式化器设置日志信息的格式,内容,它由两部分组成,分别是fmt和datefmt
其中fmt是日志消息格式化字符串样式,datefmt是日期字符串样式. 如果不指定fmt,将默认使用'%(message)s',如果不指定datefmt,将默认使用ISO8601日期格式.
fmt允许使用的变量如下:
%(name)s : Logger的名字
%(levelno)s :数字标明日志就别
%(levelname)s :日志级别(INFO、WARNING、ERROR、CRITICAL)
%(pathname)s :调用日志输出函数的模块的所在完整路径
%(filename)s :调用日志输出函数的模块的文件名
%(module)s :调用日志输出函数的模块名
%(funcName)s :调用日志输出函数的函数名
%(lineo)d :调用日志输出函数的语句所在的代码行
%(created)f :当前时间,用unix标准的表示时间的浮点数表示
%(asctime)s :当前时间格式,可以自定义时间格式,如"%Y-%m-%d %H:%M:%S"
%(message)s :用户自定义的日志消息
说了那么多,还是来实践一把吧,代码如下:
import logging
try:
conn = mysql.connector.connect(
user = db_user,
password = db_passwd,
host = db_host,
port = db_port,
database = access_db)
cur = conn.cursor()
cur.execute(unormal_task_sql)
unormal_task_results = cur.fetchall()
except Exception,e:
logger = getLogger()
logger.error('fail to get data from oss db: %s:%s,cluster_name:%s'%(db_host,db_port,cluster_name))
def getLogger(logger_name="app.log",log_level=logging.ERROR,log_path="log/app.log"):
#create logger
logger = logging.getLogger(logger_name)
#create file handler
fh = logging.FileHandler(log_path,mode='a')
fh.setLevel(log_level)
#create formatter
fmt = "%(asctime)s %(levelname)s %(lineno)d %(filename)s %(message)s"
datefmt = "%Y-%m-%d %H:%M:%S"
formatter = logging.Formatter(fmt,datefmt)
#add handler and formatter to logger
fh.setFormatter(formatter)
logger.addHandler(fh)
return logger
日志路径为:log/app.log #这个log目录需要自行创建,app.log会自动生成
logger记录器的名字为:app_log
日志级别log_level为:ERROR级别
现在来看看日志输出内容:
2018-01-26 15:04:34 ERROR 59 util.py fail to get data from oss db: xx.xx.xx.xx:3307,cluster_name:上海金桥VPC
经过实验证明,handler设置了日志级别,那么logger可以不设置日志级别,也同样可以记录日志.
网友评论