基本用法:

import logging
import sys # 获取logger实例,如果参数为空则返回root logger
logger = logging.getLogger("AppName") # 指定logger输出格式
formatter = logging.Formatter('%(asctime)s %(levelname)-8s: %(message)s') # 文件日志
file_handler = logging.FileHandler("test.log")
file_handler.setFormatter(formatter) # 可以通过setFormatter指定输出格式 # 控制台日志
console_handler = logging.StreamHandler(sys.stdout)
console_handler.formatter = formatter # 也可以直接给formatter赋值 # 为logger添加的日志处理器
logger.addHandler(file_handler)
logger.addHandler(console_handler) # 指定日志的最低输出级别,默认为WARN级别
logger.setLevel(logging.INFO) # 输出不同级别的log
logger.debug('this is debug info')
logger.info('this is information')
logger.warn('this is warning message')
logger.error('this is error message')
logger.fatal('this is fatal message, it is same as logger.critical')
logger.critical('this is critical message') # 2016-10-08 21:59:19,493 INFO : this is information
# 2016-10-08 21:59:19,493 WARNING : this is warning message
# 2016-10-08 21:59:19,493 ERROR : this is error message
# 2016-10-08 21:59:19,493 CRITICAL: this is fatal message, it is same as logger.critical
# 2016-10-08 21:59:19,493 CRITICAL: this is critical message # 移除一些日志处理器
logger.removeHandler(file_handler)

执行结果

[root@localhost python]# python t_logging.py
2018-09-06 14:09:55,829 INFO : this is information
2018-09-06 14:09:55,829 WARNING : this is warning message
2018-09-06 14:09:55,829 ERROR : this is error message
2018-09-06 14:09:55,830 CRITICAL: this is fatal message, it is same as logger.critical
2018-09-06 14:09:55,830 CRITICAL: this is critical message

格式化输出日志

# 格式化输出
service_name = "Booking"
logger.error('%s service is down!' % service_name) # 使用python自带的字符串格式化,不推荐
logger.error('%s service is down!', service_name) # 使用logger的格式化,推荐
logger.error('%s service is %s!', service_name, 'down') # 多参数格式化
logger.error('{} service is {}'.format(service_name, 'down')) # 使用format函数,推荐 # 2016-10-08 21:59:19,493 ERROR : Booking service is down!

执行结果

2018-09-06 14:13:36,177 ERROR   : Booking service is down!
2018-09-06 14:13:36,177 ERROR : Booking service is down!
2018-09-06 14:13:36,177 ERROR : Booking service is down!
2018-09-06 14:13:36,177 ERROR : Booking service is down

记录异常信息

使用logging模块记录异常信息时,不需要传入该异常对象,只要调用 logging.error() 或者 logging.eception() 就可以将当前异常记录下来

# 记录异常信息
try:
1 / 0
except:
# 等同于error级别,但是会额外记录当前抛出的异常堆栈信息
logger.exception('this is an exception message') # 2016-10-08 21:59:19,493 ERROR : this is an exception message
# Traceback (most recent call last):
# File "D:/Git/py_labs/demo/use_logging.py", line 45, in <module>
# 1 / 0
# ZeroDivisionError: integer division or modulo by zero

  

logging配置要点

getLogger()  这时最基本的入口,该方法参数可以为空,默认的logging名称是root,如果在同一程序中一直都使用同名的logger,其实会拿到同一实例,使用这个技巧就可以跨模块调用同样的logger来记录日志

另外,也可以通过日志名称来区分同一程序的不同模块,比如:

logger = logging.getLogger("App.UI")
logger = logging.getLogger("App.Service")

Formatter  这个对象定义了log信息的结构和内容,构造时需要带两个参数:

一个格式化模板 fmt ,默认会包含基本的level和message信息

一个是格式化的时间样式 datefmt ,默认为 2003-07-08 16:49:45,896 (%Y-%m-%d %H:%M:%S)

fmt 中允许使用的变量可以参考下表:

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

setLevel

Logging有以下级别:DEBUG,INFO,WARNING,ERROR,CRITICAL

默认级别是WARNING,logging模块只会输出指定level以上的log,这样的好处,就是在项目开发时debug用的Log,在产品release阶段不用一一注释,只需要调整logger的级别就可以了,很方便

Handler

最常用的是StreamHandler和FileHandler,Handler用于向不同的输出端打log

Logging包含很多handler,可能用到的有下面几种:

  • StreamHandler:instances send error message to streams( file-like objects )
  • FileHandler:instances send error message to disk files
  • RotatingFileHandler:instances send error message to disk files, with support for maximum log file sizes and log file rotation
  • TimeRotatingFileHandler:instances send error message to disk files, rotating the log file at certain timed intervals
  • SocketHandler:instances send error message to TCP/IP sockets
  • DatagramHandler:instances send error message to UDP sockets
  • SMTPHandler:instances send error message to designated email address

Configuration

logging的配置方式大概有以下几种:

  1. 通过代码进行完整配置,参考开头的例子,主要是通过getLogger方法实现
  2. 通过代码进行简单配置,下面有例子,主要是通过basicConfig方法实现
  3. 通过配置文件,下面有例子,主要是通过logging.config.fileConfig(filepath)

logging.basicConfig;

这个方法提供了非常便捷的方式来配置logging模块并马上开始使用,栗子如下:

import logging
logging.basicConfig(filename='example.log',level=logging.DEBUG)
logging.debug('This message should go to the log file') logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console') logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
logging.warning('is when this event was logged.')

  备注:其实甚至可以什么都不配置直接使用默认值在控制台打log,用这样的方式替换print方法对日后项目的维护有很大帮助

通过文件配置logging

如果希望通过配置文件来管理logging,可以参考官方文档,在log4net或者log4j中是很常见的方式

# logging.conf
[loggers]
keys=root [logger_root]
level=DEBUG
handlers=consoleHandler
#,timedRotateFileHandler,errorTimedRotateFileHandler #################################################
[handlers]
keys=consoleHandler,timedRotateFileHandler,errorTimedRotateFileHandler [handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,) [handler_timedRotateFileHandler]
class=handlers.TimedRotatingFileHandler
level=DEBUG
formatter=simpleFormatter
args=('debug.log', 'H') [handler_errorTimedRotateFileHandler]
class=handlers.TimedRotatingFileHandler
level=WARN
formatter=simpleFormatter
args=('error.log', 'H') #################################################
[formatters]
keys=simpleFormatter, multiLineFormatter [formatter_simpleFormatter]
format= %(levelname)s %(threadName)s %(asctime)s: %(message)s
datefmt=%H:%M:%S [formatter_multiLineFormatter]
format= ------------------------- %(levelname)s -------------------------
Time: %(asctime)s
Thread: %(threadName)s
File: %(filename)s(line %(lineno)d)
Message:
%(message)s datefmt=%Y-%m-%d %H:%M:%S

  假设上面配置文件放在模块相同的目录,代码调用如下:

import os
filepath = os.path.join(os.path.dirname(__file__), 'logging.conf')
logging.config.fileConfig(filepath)
return logging.getLogger()

  

日志重复输出的坑

可能会看到日志重复输出,可能原因很多,但是总结下来,就一个,日志中多个重复的handler

import logging

logging.basicConfig(level=logging.DEBUG)

fmt = '%(levelname)s:%(message)s'
console_handler = logging.StreamHandler()
console_handler.setFormatter(logging.Formatter(fmt))
logging.getLogger().addHandler(console_handler) logging.info('hello!') # INFO:root:hello!
# INFO:hello!

  上面的例子出现了重复日志,因为在第三行调用了 basicConfig() 方法时系统会默认创建一个handler,如果再添加控制台handler时就会出现重复日志

import logging

def get_logger():
fmt = '%(levelname)s:%(message)s'
console_handler = logging.StreamHandler()
console_handler.setFormatter(logging.Formatter(fmt))
logger = logging.getLogger('App')
logger.setLevel(logging.INFO)
logger.addHandler(console_handler)
return logger def call_me():
logger = get_logger()
logger.info('hi') call_me()
call_me() # INFO:hi
# INFO:hi
# INFO:hi

  在上面的例子,日志重复三次,如果再调用一次 call_me ,就会输出6次,原因是每次调用 get_handler() 方法时都会添加新的handler,正常做法是全局只配置logger一次

import logging

def get_logger():
fmt = '%(levelname)s: %(message)s'
console_handler = logging.StreamHandler()
console_handler.setFormatter(logging.Formatter(fmt))
logger = logging.getLogger('App')
logger.setLevel(logging.INFO)
logger.addHandler(console_handler)
return logger def foo():
logging.basicConfig(format='[%(name)s]: %(message)s')
logging.warn('some module use root logger') def main():
logger = get_logger()
logger.info('App start.')
foo()
logger.info('App shutdown.') main() # INFO: App start.
# [root]: some module use root logger
# INFO: App shutdown.
# [App]: App shutdown.

  为什么最后 App shutdown 打印两次,在StackoverFlow上很多人问,应该怎样把root logger关掉。只要你在程序中使用root logger,那么默认你打印的日志都算它一份,上面的例子没有好的办法,建议是不用乱用root logger,如果真的想禁用root logger,有两个不是办法的办法:

logging.getLogger().handlers = []  # 删除所有的handler
logging.getLogger().setLevel(logging.CRITICAL) # 将它的级别设置到最高

  

Python的日志模块logging,是标准库的一部分,功能比较完善,上手简单,也支持过滤,文件锁等高级功能,能满足大多数项目需求。

转载自他人

Python模块logging的更多相关文章

  1. python模块 ---logging模块

    摘要by crazyhacking: 与log4cxx一样,分为三个部分,logger, handler,formatter. 详细内容参考:1官网http://docs.python.org/2/h ...

  2. Python模块——logging模块

    logging模块简介 logging模块定义的函数和类为应用程序和库的开发实现了一个灵活的事件日志系统.logging模块是Python的一个标准库模块, 由标准库模块提供日志记录API的关键好处是 ...

  3. python模块--logging

    一.logging模块的简单应用 import logging logging.debug('debug message') logging.info('ingo message') logging. ...

  4. python模块-logging的智商上限

    logging,故名肆意就是正在进行日志,我艹,这个文化底蕴! logging是python内置的日志模块,便于日常程序的日志写入和输出 logging共分为5个日志等级,分别是: debug , i ...

  5. Python模块-logging模块(一)

    logging模块用来写日志文件 有5个级别,debug(),info(),warning(),error()和critical(),级别最高的为critical() debug()为调试模式,inf ...

  6. [Python 模块] logging模块、Logger类

    logging模块: 标准库里面的logging模块,在前面学习线程安全时曾用来解决print被打断的问题,这里会介绍logging模块的功能. logging模块是线程安全的,不需要客户做任何特殊的 ...

  7. Python模块-logging模块(二)

    logging模块记录日志有四个主要类:logger,handler,formatter,filter logger提供了应用程序可以直接使用的接口,每个程序在输出信息之前都要获得一个Logger h ...

  8. python 模块之-logging

    python  模块logging import logging ###  简单使用格式    日志级别等级CRITICAL > ERROR > WARNING > INFO > ...

  9. python的logging日志模块(二)

    晚上比较懒,直接搬砖了. 1.简单的将日志打印到屏幕   import logging logging.debug('This is debug message') logging.info('Thi ...

随机推荐

  1. vuex 管理状态

    来分析下vuex的管理状态吧,如果你用过react中的redux的管理树,那我觉得vuex对你来说很容易掌握 如果你还是不太熟悉vuex是什么,那先看下官网https://vuex.vuejs.org ...

  2. VC内联汇编和GCC内联汇编的语法区别

    VC: #include <stdio.h> main(){ int a = 1; int b = 2; int c; __asm{ mov eax,a mov ebx,b mov ecx ...

  3. 【BZOJ3684】大朋友和多叉树(拉格朗日反演)

    题目链接 题意 求满足如下条件的多叉树个数: 1.每一个点的儿子个数在给定的集合 \(S\) 内 2.总的叶子节点树为 \(s\) 儿子之间有顺序关系,但节点是没有标号的. Sol 拉格朗日反演板子题 ...

  4. CMDB架构需求实现

    CMDB资产管理部分实现 需求 1.存储所有IT资产信息 2.数据可手动添加 3.硬件信息可自动收集 4.硬件信息可自动变更 5.可对其他系统灵活开放API 6.API接口安全认证 立业之本:定义表结 ...

  5. 【leetcode】1178. Number of Valid Words for Each Puzzle

    题目如下: With respect to a given puzzle string, a word is valid if both the following conditions are sa ...

  6. 恩友歌 What a friend we've found 歌词

      Verse 1   何等恩友仁慈救主 负我罪孽担我忧 何等权利能将万事 来到耶稣座前求 多少平安我们坐失 多少痛苦冤枉受 都是因为未将万事 来到耶稣座前求     Verse 2   我们有无试探 ...

  7. js-弹框倒计时三秒后,自动关闭???

    效果: js: //弹出窗,三秒倒计时 countdown(){ //点击发布按钮后,三秒倒计时开始 $(".btn-pub").click(function(){ var cou ...

  8. python 面向对象_2

    self的理解 通俗理解self就是实例对象,实例化的是什么,self就是什么 实例变量: 经过实例化才能使用的变量 class Person(): def __init__(self,id,name ...

  9. mysql中查看ef或efcore生成的sql语句

    http://www.solves.com.cn/it/sjk/MYSQL/2019-07-01/1336.html 涉及命令 1.开启general log模式 MySQL>set globa ...

  10. leetcode-mid-others-169. Majority Element¶

    mycode  54.93% class Solution(object): def majorityElement(self, nums): """ :type num ...