首页 > 关于使用python logging模块的几点总结

关于使用python logging模块的几点总结

关于使用python logging模块的几点总结

使用python的标准日志模块logging可以非常方便地记录日志。Python日志系统非常丰富。添加结构化或非结构化日志输出到python代码，写到文件，输出到控制台，发送到系统日志，或者自定义输出格式都很容易。

下面是我实践过程中遇到的一些经验和教训的总结。

1. 一个简单的日志系统示例

业务场景如下：

开发一个日志系统， 既要把日志输出到控制台， 还要写入日志文件

#!/usr/bin/env python
#encoding: utf-8import logging#创建一个logger实例
logger = logging.getLogger('mylogger')
logger.setLevel(logging.DEBUG)#创建一个handler,用于写入日志文件
fh = logging.FileHandler('simple_log.log')
fh.setLevel(logging.DEBUG)#创建一个handler,用于输出到控制台
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)#定义handler的输出格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)#给logger添加handler
logger.addHandler(fh)
logger.addHandler(ch)#记录一条日志
logger.info('foobar')

运行后， 在控制台和日志文件都有一条日志：





2. logging模块的API

结合上面的例子，我们说下几个最常使用的API

logging.getLogger([name])

返回一个logger实例，如果没有指定name，返回root logger。

只要name相同，返回的logger实例都是同一个而且只有一个，即name和logger实例是一一对应的。这意味着，无需把logger实例在各个模块中传递。只要知道name，就能得到同一个logger实例



Logger.setLevel(lvl)

设置logger的level， level有以下几个级别：



NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL

如果把looger的级别设置为INFO， 那么小于INFO级别的日志都不输出， 大于等于INFO级

别的日志都输出

logger.debug("foobar")    # 不输出   

logger.info("foobar")        # 输出  

logger.warning("foobar") # 输出  

logger.error("foobar")      # 输出  

logger.critical("foobar")    # 输出  

 

Logger.addHandler(hdlr)

logger可以雇佣handler来帮它处理日志， handler主要有以下几种：

StreamHandler: 输出到控制台

FileHandler:   输出到文件

handler还可以设置自己的level以及输出格式。



logging.basicConfig([**kwargs])

* 这个函数用来配置root logger， 为root logger创建一个StreamHandler，

   设置默认的格式。

* 这些函数： logging.debug()、logging.info()、logging.warning()、

   logging.error()、logging.critical() 如果调用的时候发现root logger没有任何

   handler， 会自动调用basicConfig添加一个handler

* 如果root logger已有handler， 这个函数不做任何事情



使用basicConfig来配置root logger的输出格式和level： 

import logging  
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)  
logging.debug('This message should appear on the console')




3. 日志对象间的层级结构

除了root logger， 实际上logger实例之间还有父子关系， root logger就是处于最顶层的logger， 它是所有logger的祖先。如下图:



root logger是默认的logger

如果不创建logger实例， 直接调用logging.debug()、logging.info()logging.warning()、logging.error()、logging.critical()这些函数，

那么使用的logger就是 root logger， 它可以自动创建，也是单实例的。



如何得到root logger

通过logging.getLogger()或者logging.getLogger("")得到root logger实例。



默认的level

root logger默认的level是logging.WARNING



如何表示父子关系

logger的name的命名方式可以表示logger之间的父子关系. 比如：

parent_logger = logging.getLogger('foo')

child_logger = logging.getLogger('foo.bar')

什么是effective level

logger有一个概念，叫effective level。 如果一个logger没有显示地设置level，那么它就

用父亲的level。如果父亲也没有显示地设置level， 就用父亲的父亲的level，以此推....

最后到达root logger，一定设置过level。默认为logging.WARNING

child loggers得到消息后，既把消息分发给它的handler处理，也会传递给所有祖先logger处理，



来看一个例子 

#!/usr/bin/env python
#encoding: utf-8import logginglogging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')r = logging.getLogger()ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
r.addHandler(ch)p = logging.getLogger('foo')
p.setLevel(logging.DEBUG)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(message)s')
ch.setFormatter(formatter)
p.addHandler(ch)c = logging.getLogger('foo.bar')
c.debug('foo')
输出如下：







可见，孩子logger没有任何handler，所以对消息不做处理。但是它把消息转发给了它的父亲以及root logger。最后输出四条日志。



参考文献

[1].http://kenby.iteye.com/blog/1162698

更多相关：

  • logging模块

      import logging from conf import settingsdef logger(log_type):# 生成 logger 对象logger = logging.getLogger(log_type)logger.setLevel(settings.LOG_LEVEL)# 生成handler对象，向文件输出...

  • Udacity机器人软件工程师课程笔记（二十九) - 全卷积网络（FCN）

    全卷积网络（FCN） 1.全卷积神经网络介绍 FCN对图像进行像素级的分类，从而解决了语义级别的图像分割（semantic segmentation）问题。与经典的CNN在卷积层之后使用全连接层得到固定长度的特征向量进行分类（全联接层＋softmax输出）不同，FCN可以接受任意尺寸的输入图像，采用反卷积层对最后一个卷积层的fea...

  • PHP函数printf()、sprintf()的用法

    printf()函数优点在于可以格式化输出 格式: 　　%['padding_character][-][width][.precision]type 　　所有的转换说明都是以%开始,如果想打印一个%符号,必须用%% ； 　　参数“'padding_character”是可选，它将被用来填充变量直至所指定的宽度，该参...

  • L1-023 输出GPLT (C++解决，含题解)

    给定一个长度不超过10000的、仅由英文字母构成的字符串。请将字符重新调整顺序，按GPLTGPLT....这样的顺序输出，并忽略其它字符。当然，四种字符（不区分大小写）的个数不一定是一样多的，若某种字符已经输出完，则余下的字符仍按GPLT的顺序打印，直到所有字符都被输出。 输入格式： 输入在一行中给出一个长度不超过10000的、仅...

  • L1-008 求整数段和 (C++)

    给定两个整数A和B，输出从A到B的所有整数以及这些数的和。 输入格式： 输入在一行中给出2个整数A和B，其中−100≤A≤B≤100，其间以空格分隔。 输出格式： 首先顺序输出从A到B的所有整数，每5个数字占一行，每个数字占5个字符宽度，向右对齐。最后在一行中按Sum = X的格式输出全部数字的和X。 输入样例：...

  • python面试题目

    python面试题目 原文地址：https://www.usblog.cc/blog/post/justzhl/b5cc9a05c7d2 问题一：以下的代码的输出将是什么? 说出你的答案并解释。 ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 class Parent(object):     x...

  • qt能使用logback_使用ELK系统分析SpringBoot日志

    ELK:(ELK 由 ElasticSearch 、 Logstash 和 Kiabana 三个开源工具组成),Elasticsearch用于存储日志信息，Logstash用于收集日志，Kibana用于图形化展示。上一节我们介绍了如何使用docker-compose搭建ELK日志分析系统。传送门：传说中的ELK日志分析系统，手把手教你...

  • qt能使用logback_Spring boot使用logback实现日志配置

    欢迎关注头条号：老顾聊技术精品原创技术分享，知识的组装工目录前言常用日志组件什么是日志门面和日志实现常见的日志框架日志使用@slf4j注解日志的配置logback-spring配置总结前言日志是我们系统必备的功能之一，可以帮助我们开发人员定位系统的异常、错误以及运行流程的重要的工具。今天老顾就来介绍一下Spring boot的默认的l...

  • Go的日志模块glog调研笔记

    glog简介 glog是著名的google开源C++日志库glog(https://github.com/google/glog)的golang版本，glog是一个轻量级的日志库，上手简单不需要配置文件并且稳定高效，可以自定义控制的内容比较少。  glog主要有以下几个特点：  1. glog有四种日志等级INFO < WARING...

  • ATS 5.3.0中按域名生成日志配置文件log_hosts.config解读

    应用场景 该配置文件用于ATS用作反向代理模式，访问日志被server域名分隔。比如，我想将sohu和ifeng的域名的日志分别记在两个不同的日志文件中，其它的日志统一记在默认的日志文件中。 配置 为了将不同源站的HTTP transaction记录在不同的日志文件中，你必须在log_hosts.config中列举出每...

  • ATS 5.3.0中自定义日志格式文件logs_xml.config解读

    缘起 近来因为公司项目需要，阅读了一部分ATS logging system的源码实现，越发觉得logs_xml.config文件的配置非常重要，而我目前只是实践了一点它的皮毛。为此，根据自己的理解，翻译了官网的这篇文档，以作备忘。 logs_xml.config文件定义了自定义日志文件格式，过滤器和处理选项。文件格式采用x...

©2024 11GX.COM