python的logging模块

logging模块提供了两种记录日志的方式:
一种是使用logging提供的模块级别的函数;
另一种是使用logging的四大组件(Logger、Handler、Filter、Formatter)。

使用logging模块级别函数记录日志

logging.debug(msg, *args, **kwargs)
logging.info(msg, *args, **kwargs)
logging.warning(msg, *args, **kwargs)
logging.error(msg, *args, **kwargs)
logging.critical(msg, *args, **kwargs)
logging.log(level, *args, **kwargs)
logging.basicConfig(**kwargs)
其中,logging.basicConfig(**kwargs)用于指定日志的级别、日志格式、日志输出的位置、日志文件的打开模式等。

import logging
logging.basicConfig(level=logging.DEBUG, 
                    format='%(levelname)s: %(threadname)s: %(asctime)s: %(message)s', 
                    datefmt='%Y-%m-%d %H:%M:%s', filename='example.log', filemode='w')  
# filemode='w'表示清空example.log中的日志重新写入
logging.debug('debug')
logging.info('info')
logging.warning('warning')
logging.error('error')
logging.critical('critical')
logging.log(level=logging.INFO, 'info by log')

使用logging四大组件记录日志

logging的四大组件分别为:日志器Logger、处理器Handler、过滤器Filter和格式器Formatter,四者的关系为:
Logger需要通过Handler将日志信息输出到目标位置,如文件、sys.stdout、网络等;
Logger可以设置多个处理器将日志输出到不同的地方;
每个Handler都可以设置自己的过滤器实现日志过滤,从而只保留需要的日志;
每个Handler都可以设置自己的Formatter来设置不同的格式。

创建日志器

可以通过实例化Logger来创建一个日志器,也可以通过logging.getLogger()的方法来创建,一般推荐使用后者。logging.getLogger()方法有一个name参数,用于指定返回的日志器的名称,如果不指定的话默认为root。

myLogger = logging.getLogger('myLogger')
myLogger.setLevel(logging.DEBUG)  # 设置Logger的日志等级
添加处理器

Logger对象可以通过addHandler(handler)方法为自己添加一个或多个处理器。那么Handler怎么创建呢?一般不建议直接实例化Handler类来创建,以下给出一些常用的handler:

Handler 描述
logging.StreamHandler 将日志信息发送到stream, 如std.out、std.err或任何file-like对象
logging.FileHander 将日志信息发送到磁盘文件,默认条件下文件大小会无限增长
logging.handlers.RotatingFileHandler 将日志信息发送到磁盘文件,并将文件按大小切割
logging.handlers.TimeRotatingFileHander 将日志信息发送到磁盘文件,并将文件按时间切割
logging.handlers.HTTPHandler 将日志信息以GET或POST的方式发送到HTTP服务器
logging.handlers.SMTPHandler 将日志信息发送给指定的email地址
logging.NullHandler 该Handler实例会忽略error messages,通常被想使用logging的library开发者使用来避免'No handlers could be found for logger XXX'信息的出现。
fileHandler = logging.handlers.TimeRotatingHandler(filename='example.log', when='d', interval=1, encoding='utf-8')
fileHandler.setLevel(logging.INFO)  # 设置该handler的日志等级
myLogger.addHandler(fileHandler)
添加格式器

与Handler不同,Formatter可以通过直接实例化添加。Formatter的构造函数如下
logging.Formatter.__init__(fmt=None, datefmt=None, style='%')
该构造方法有三个可选参数:
· fmt:指定消息格式化字符串
· datefmt:指定时间的格式
· style:可取值为%、{、$,默认为%,此时fmt字符串的格式为%(<dictionary key>)s;如果取值{,则fmt字符串的格式为str.format();如果取值美元符号,则fmt字符串的格式为string.Template.substitute()

formatter = logging.Formatter('%(asctime)s %(thread)s: %(message)s', datefmt='%Y-%m-%d %H:%M:%s')
fileHandler.setFormatter(formatter)
过滤器

Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能。Filter是一个过滤器基类,它只允许某个logger层级下的日志事件通过过滤。(没用过,以后再看...)

日志流处理流程
image.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容

  • 一、logging模块四大组件类 日志器Logger:提供程序一直使用的接口; 处理器Handler:将日志器创建...
    rr1990阅读 5,013评论 0 2
  • 本文章是我大概三年前,在上家单位使用 Python 工作时结合官方文档做的整理。现在 Python 官方文档听说已...
    好吃的野菜阅读 212,431评论 14 231
  • logging模块当中,记录到log的信息等级划分:从低到高 调试(debug)、信息(info)、警告(warn...
    卅清阅读 1,075评论 0 0
  • 在之前的多个项目中都有用到过logging模块,虽然用过,但没有研究过,只是在每个代码文件中使用logger=lo...
    KenHan阅读 875评论 0 2
  • 久违的晴天,家长会。 家长大会开好到教室时,离放学已经没多少时间了。班主任说已经安排了三个家长分享经验。 放学铃声...
    飘雪儿5阅读 7,395评论 16 21