python 日志子產品 logging

Java 中最通用的日志子產品莫過于 Log4j 了，在 python 中，也自帶了 logging 子產品，該子產品的用法其實和 Log4j 類似。

Python 使用logging子產品記錄日志涉及四個主要類，使用官方文檔中的概括最為合适：

logger提供了應用程式可以直接使用的接口；

handler将(logger建立的)日志記錄發送到合适的目的輸出；

filter提供了細度裝置來決定輸出哪條日志記錄；

formatter決定日志記錄的最終輸出格式。

logging子產品是在2.3新引進的功能，下面是一些常用的類和子產品級函數

子產品級函數

logging.getLogger([name]):傳回一個logger對象，如果沒有指定名字将傳回root logger

logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()：設定root logger的日志級别

logging.basicConfig():用預設Formatter為日志系統建立一個StreamHandler，設定基礎配置并加到root logger中

Logger

python 日志子產品 logging

每個程式在輸出資訊之前都要獲得一個Logger。Logger通常對應了程式的子產品名，比如聊天工具的圖形界面子產品可以這樣獲得它的Logger：

LOG=logging.getLogger(”chat.gui”)

而核心子產品可以這樣：

LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志級别，低于lel的級别将被忽略。debug是最低的内置級别，critical為最高

Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter

Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler

Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以設定的日志級别

設定logger的level， level有以下幾個級别：

In []: import logging

In []: logging.NOTSET
Out[]: 

In []: logging.DEBUG
Out[]: 

In []: logging.INFO
Out[]: 

In []: logging.WARNING
Out[]: 

In []: logging.ERROR
Out[]: 

In []: logging.CRITICAL
Out[]:

NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL

如果把looger的級别設定為INFO，那麼小于INFO級别的日志都不輸出，大于等于INFO級别的日志都輸出

Handlers

handler對象負責發送相關的資訊到指定目的地。Python的日志系統有多種Handler可以使用。有些Handler可以把資訊輸出到控制台，有些Logger可以把資訊輸出到檔案，還有些 Handler可以把資訊發送到網絡上。如果覺得不夠用，還可以編寫自己的Handler。可以通過addHandler()方法添加多個多handler

Handler.setLevel(lel):指定被處理的資訊級别，低于lel級别的資訊将被忽略

Handler.setFormatter()：給這個handler選擇一個格式

Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一個filter對象

Formatters

Formatter對象設定日志資訊最後的規則、結構和内容，預設的時間格式為%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些資訊

%(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

使用者輸出的消息

設定過濾器

細心的朋友一定會發現前文調用logging.getLogger()時參數的格式類似于“A.B.C”。采取這樣的格式其實就是為了可以配置過濾器。看一下這段代碼：

LOG=logging.getLogger(”chat.gui.statistic”)

console = logging.StreamHandler()

console.setLevel(logging.INFO)

formatter = logging.Formatter(’%(asctime)s %(levelname)s %(message)s’)

console.setFormatter(formatter)

filter=logging.Filter(”chat.gui”)

console.addFilter(filter)

LOG.addHandler(console)

和前面不同的是我們在Handler上添加了一個過濾器。現在我們輸出日志資訊的時候就會經過過濾器的處理。名為“A.B”的過濾器隻讓名字帶有 “A.B”字首的Logger輸出資訊。可以添加多個過濾器，隻要有一個過濾器拒絕，日志資訊就不會被輸出。另外，在Logger中也可以添加過濾器。

每個Logger可以附加多個Handler。接下來我們就來介紹一些常用的Handler：

1) logging.StreamHandler

使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何檔案對象(file object)輸出資訊。它的構造函數是：

StreamHandler([strm])

其中strm參數是一個檔案對象。預設是sys.stderr

2) logging.FileHandler

和StreamHandler類似，用于向一個檔案輸出日志資訊。不過FileHandler會幫你打開這個檔案。它的構造函數是：

FileHandler(filename[,mode])

filename是檔案名，必須指定一個檔案名。

mode是檔案的打開方式。參見Python内置函數open()的用法。預設是’a’，即添加到檔案末尾。

3) logging.handlers.RotatingFileHandler

這個Handler類似于上面的FileHandler，但是它可以管理檔案大小。當檔案達到一定大小之後，它會自動将目前日志檔案改名，然後建立一個新的同名日志檔案繼續輸出。比如日志檔案是chat.log。當chat.log達到指定的大小之後，RotatingFileHandler自動把檔案改名為chat.log.1。不過，如果chat.log.1已經存在，會先把chat.log.1重命名為chat.log.2。。。最後重新建立 chat.log，繼續輸出日志資訊。它的構造函數是：

RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

其中filename和mode兩個參數和FileHandler一樣。

maxBytes用于指定日志檔案的最大檔案大小。如果maxBytes為0，意味着日志檔案可以無限大，這時上面描述的重命名過程就不會發生。

backupCount用于指定保留的備份檔案的個數。比如，如果指定為2，當上面描述的重命名過程發生時，原有的chat.log.2并不會被更名，而是被删除。

4) logging.handlers.TimedRotatingFileHandler

這個Handler和RotatingFileHandler類似，不過，它沒有通過判斷檔案大小來決定何時重新建立日志檔案，而是間隔一定時間就自動建立新的日志檔案。重命名的過程與RotatingFileHandler類似，不過新的檔案不是附加數字，而是目前時間。它的構造函數是：

TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

其中filename參數和backupCount參數和RotatingFileHandler具有相同的意義。

interval是時間間隔。

when參數是一個字元串。表示時間間隔的機關，不區分大小寫。它有以下取值：

S 秒

M 分

H 小時

D 天

W 每星期（interval==0時代表星期一）

midnight 每天淩晨

5) logging.handlers.SocketHandler

6) logging.handlers.DatagramHandler

以上兩個Handler類似，都是将日志資訊發送到網絡。不同的是前者使用TCP協定，後者使用UDP協定。它們的構造函數是：

Handler(host, port)

其中host是主機名，port是端口名

7) logging.handlers.SysLogHandler

8) logging.handlers.NTEventLogHandler

9) logging.handlers.SMTPHandler

10) logging.handlers.MemoryHandler

11) logging.handlers.HTTPHandler

最後舉幾個例子：

# encoding:utf-
# import logging

# FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
#logging.basicConfig(format=FORMAT)
#d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
#logger = logging.getLogger('tcpserver')
#logger.warning('Protocol problem: %s', 'connection reset', extra=d)

#FORMAT = '%(asctime)-15s %(message)s'
#logging.basicConfig(filename = "C:\\Users\\june\\Desktop\\1.txt", level = logging.DEBUG, filemode = "a", format=FORMAT)  
#logging.debug('this is a message')  
#logging.debug('test')

#import logging
#import datetime
#
#curDate = datetime.date.today() - datetime.timedelta(days=0)
#logName =  'C:\\Users\\june\\Desktop\\error_%s.log' %curDate
#
#logging.basicConfig(level=logging.INFO,
#               format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
#               #datefmt='%a, %d %b %Y %H:%M:%S',
#               filename=logName,
#               filemode='a')
#
##2013-10-21 03:25:51,509 writeLog.py[line:14] INFO This is info message
##2013-10-21 03:25:51,510 writeLog.py[line:15] WARNING This is warning message
#logging.debug('This is debug message')
#logging.info('This is info message')
#logging.warning('This is warning message')

import logging
import logging.config

logging.config.fileConfig("logging.conf")

#create logger
loggerInfo = logging.getLogger("infoLogger")

#"application" code
loggerInfo.debug("debug message")
loggerInfo.info("info message")
loggerInfo.warn("warn message")
loggerInfo.error("error message")
loggerInfo.critical("critical message")


loggerError = logging.getLogger("errorLogger")
loggerError.error("Error: Hello world!")

# 定義logger子產品，root是父類，必需存在的，其它的是自定義。
# logging.getLogger(NAME)便相當于向logging子產品注冊了一種日志列印
# name 中用 . 表示 log 的繼承關系
[loggers]
keys=root,infoLogger,errorLogger

# 定義handler
[handlers]
keys=infoHandler,errorHandler

# 定義格式化輸出
[formatters]
keys=infoFmt,errorFmt

#--------------------------------------------------
# 實作上面定義的logger子產品，必需是[logger_xxxx]這樣的形式
#--------------------------------------------------
# [logger_xxxx] logger_子產品名稱
# level     級别，級别有DEBUG、INFO、WARNING、ERROR、CRITICAL
# handlers  處理類，可以有多個，用逗号分開
# qualname  logger名稱，應用程式通過 logging.getLogger擷取。對于不能擷取的名稱，則記錄到root子產品。
# propagate 是否繼承父類的log資訊，0:否 1:是
[logger_root]
level=INFO
handlers=errorHandler

[logger_errorLogger]
level=ERROR
handlers=errorHandler
propagate=0
qualname=errorLogger

[logger_infoLogger]
level=INFO
handlers=infoHandler
propagate=0
qualname=infoLogger

#--------------------------------------------------
# handler
#--------------------------------------------------
# [handler_xxxx]
# class handler類名
# level 日志級别
# formatter，上面定義的formatter
# args handler初始化函數參數

[handler_infoHandler]
class=StreamHandler
level=INFO
formatter=infoFmt
args=(sys.stdout,)

[handler_errorHandler]
class=logging.handlers.TimedRotatingFileHandler
level=ERROR
formatter=errorFmt
# When computing the next rollover time for the first time (when the handler is created),
# the last modification time of an existing log file, or else the current time,
# is used to compute when the next rotation will occur.
# 這個功能太雞肋了，是從handler被建立的時間算起，不能按自然時間 rotation 切分，除非程式一直運作，否則這個功能會有問題
# 臨時解決方案參考下面的連結：Python 多程序日志記錄
# http://blogread.cn/it/article/4175?f=wb2
args=('C:\\Users\\june\\Desktop\\error.log', 'M', 1, 5)

#--------------------------------------------------
# 日志格式
#--------------------------------------------------
# %(asctime)s       年-月-日 時-分-秒,毫秒 2013-04-26 20:10:43,745
# %(filename)s      檔案名，不含目錄
# %(pathname)s      目錄名，完整路徑
# %(funcName)s      函數名
# %(levelname)s     級别名
# %(lineno)d        行号
# %(module)s        子產品名
# %(message)s       消息體
# %(name)s          日志子產品名
# %(process)d       程序id
# %(processName)s   程序名
# %(thread)d        線程id
# %(threadName)s    線程名

[formatter_infoFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

[formatter_errorFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

#coding=utf-8
import logging
import datetime

format='%(asctime)s - %(filename)s - [line:%(lineno)d] - %(levelname)s - %(message)s'
curDate = datetime.date.today() - datetime.timedelta(days=)
infoLogName =  r'C:/Users/june/Desktop/info_%s.log' %curDate
errorLogName =  r'C:/Users/june/Desktop/error_%s.log' %curDate

formatter = logging.Formatter(format)

infoLogger = logging.getLogger("infoLog")
errorLogger = logging.getLogger("errorLog")

infoLogger.setLevel(logging.INFO)
errorLogger.setLevel(logging.ERROR)

infoHandler = logging.FileHandler(infoLogName, 'a')
infoHandler.setLevel(logging.INFO)
infoHandler.setFormatter(formatter)

errorHandler = logging.FileHandler(errorLogName, 'a')
errorHandler.setLevel(logging.ERROR)
errorHandler.setFormatter(formatter)

testHandler = logging.StreamHandler()
testHandler.setFormatter(formatter)
testHandler.setLevel(logging.ERROR)

infoLogger.addHandler(infoHandler)
infoLogger.addHandler(testHandler)
errorLogger.addHandler(errorHandler)

#infoLogger.debug("debug message")
#infoLogger.info("info message")
#infoLogger.warn("warn message")
# # 下面這行會同時列印在檔案和終端上
#infoLogger.error("error message")
#
#errorLogger.error("error message")
#errorLogger.critical("critical message")

參考：

Python标準子產品logging http://blog.csdn.net/fxjtoday/article/details/6307285

Logging Cookbook http://docs.python.org/2/howto/logging-cookbook.html

REF：

[1] logging — Logging facility for Python

http://docs.python.org/2/library/logging.html

[2] logging.config — Logging configuration

http://docs.python.org/2/library/logging.config.html#module-logging.config

[3] 使用python的logging子產品

http://kenby.iteye.com/blog/1162698

http://gashero.yeax.com/?p=16

http://blog.sina.com.cn/s/blog_51294ca50100gc3x.html

http://www.cnblogs.com/captain_jack/archive/2011/01/21/1941453.html

[4] 使用Python的logging.config

http://www.cppblog.com/jinq0123/archive/2007/09/03/UsingLoggingConfig.html

[5] python之強大的日志子產品logging

http://www.stamhe.com/?p=862

[6] 每個 Python 程式員都要知道的日志實踐

http://python.jobbole.com/81666/

[7] python日志管理：logging

http://wjdadi-gmail-com.iteye.com/blog/1984354

[8] Python Howto 之 logging 子產品

http://python.jobbole.com/82221/

[9] 關于 logging 的一些瑣事

http://python.jobbole.com/84092/

python 日志子產品 logging

繼續閱讀

來自python的【條件控制/語句循環/break/continue/else/pass】一、條件控制二、語句循環

無法解析的外部符号 wmain，該符号在函數 "void cdecl mainCRTStartupHelper(struct HINSTANCE *,unsigned short con......

TestLink導出用例轉換工具(XML2Excel)

YAML簡介和PyYAML安全操作YAML支援的類型YAML的優點：yaml的基本文法python操作

Small tricks

libsvm for python 安裝

學習軟體測試基礎測試第七天

Zeppelin 配置通路 REST APIApache Zeppelin Configuration REST API

【Torch】最簡潔logging使用指南

27. Remove Element(清單)題目代碼

Cloud Studio初體驗

使用 ctypes 進行 Python 和 C 的混合程式設計

【python】【資料處理】畫多元資料分布圖

【python】netconf協定對接管理裝置

「Python 網絡自動化」NETCONF —— Python 使用 NETCONF 管理配置 H3C 網絡裝置

在python中建立excel并寫入