python logging模塊

概述：

python的logging模塊提供了標準的日誌接口，你能夠經過它存儲各類格式的日誌，logging的日誌能夠分爲 debug(), info(), warning(), error() and critical() 5個級別。

 

logging 日誌信息的簡單用法

默認的，日誌級別要高於INFO級別纔會有內容輸出。

import logging

logging.debug("user[root] this is a {debug} message..")
logging.info("user[root] this is a {info} message..")
logging.warning("The server is down. this is a {warning} message..")
logging.error("the password is error,con't to login . this is a {error} message..")
logging.critical("user[root] this is a critical message..")

"""
WARNING:root:The server is down. this is a {warning} message..
ERROR:root:the password is error,con't to login . this is a {error} message..
CRITICAL:root:user[root] this is a critical message..
"""

logging 5個日誌級別表明的意思：

 

將logging日誌信息寫到文件內

logging.basicConfig函數對日誌的輸出格式及方式作相關配置，level 設置日誌輸出的級別，farmat 設置日誌保存的格式，datefmt 設置日誌時間的格式，filename日誌保存文件的名稱，filemode文件輸入的模式：「a」爲追加。

import logging

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="myLOG.log",
                    filemode="a")
logging.debug('This message should go to the log file')
logging.info('So should this,info log')
logging.warning('This is warning message')

MyLOG.log文檔中日誌信息：

Thu, 17 Aug 2017 15:59:10 log_v1.py[line:55] INFO So should this,info log
Thu, 17 Aug 2017 15:59:10 log_v1.py[line:56] WARNING This is warning message
Thu, 17 Aug 2017 15:59:57 log_v1.py[line:55] INFO So should this,info log
Thu, 17 Aug 2017 15:59:57 log_v1.py[line:56] WARNING This is warning message

 logging日誌格式:

%(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日誌輸出到屏幕和文件中

Python 使用logging模塊記錄日誌涉及四個主要類：

logger提供了應用程序能夠直接使用的接口；

handler將(logger建立的)日誌記錄發送到合適的目的輸出；

filter提供了細度設備來決定輸出哪條日誌記錄；

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

　　　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()：能夠設置的日誌級別

 

　　handler:

handler對象負責發送相關的信息到指定目的地。Python的日誌系統有多種Handler可使用。有些Handler能夠把信息輸出到控制檯，有些Logger能夠把信息輸出到文件，還有些 Handler能夠把信息發送到網絡上。若是以爲不夠用，還能夠編寫本身的Handler。能夠經過addHandler()方法添加多個多handler
Handler.setLevel(lel):指定被處理的信息級別，低於lel級別的信息將被忽略
Handler.setFormatter()：給這個handler選擇一個格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或刪除一個filter對象

每一個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 天天凌晨

 

# 例1：

import logging
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename="myapp.log",
                    filemode="a")  #輸出到文檔

console = logging.StreamHandler() # 定義一個StreamHandler，將INFO級別或更高的日誌信息打印到標準錯誤，並將其添加到當前的日誌處理對象
console.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)-12s:%(levelname)-8s %(message)s')   # 屏幕輸出
console.setFormatter(formatter)
logging.getLogger("").addHandler(console)

logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

 

# 例2(另外一種經典寫法)：

import logging

logger = logging.getLogger("logger")
logger.setLevel(logging.DEBUG)

ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

fh = logging.FileHandler("mylog.log")
fh.setLevel(logging.DEBUG)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

ch.setFormatter(formatter)
fh.setFormatter(formatter)

logger.addHandler(ch)
logger.addHandler(fh)


# 日誌信息
logger.debug('this is debug message')
logger.info('this is info message')
logger.warn('this is warning message')
logger.error('this is error message')
logger.critical('this is critical message')

屏幕輸出的日誌信息：

2017-08-17 16:39:55,971 - logger - DEBUG - this is debug message
2017-08-17 16:39:55,971 - logger - INFO - this is info message
2017-08-17 16:39:55,971 - logger - WARNING - this is warning message
2017-08-17 16:39:55,971 - logger - ERROR - this is error message
2017-08-17 16:39:55,971 - logger - CRITICAL - this is critical message

mylog.log文件中的日誌信息：

2017-08-17 16:41:49,346 - logger - DEBUG - this is debug message
2017-08-17 16:41:49,346 - logger - INFO - this is info message
2017-08-17 16:41:49,346 - logger - WARNING - this is warning message
2017-08-17 16:41:49,346 - logger - ERROR - this is error message
2017-08-17 16:41:49,346 - logger - CRITICAL - this is critical message

　　

經過配置文件配置logger：

定義配置文件logger.conf

#logger.conf
###############################################
[loggers]
keys=root,example01,example02
[logger_root]
level=DEBUG
handlers=hand01,hand02
[logger_example01]
handlers=hand01,hand02
qualname=example01
propagate=0
[logger_example02]
handlers=hand01,hand03
qualname=example02
propagate=0
###############################################

[handlers]
keys=hand01,hand02,hand03
[handler_hand01]
class=StreamHandler
level=INFO
formatter=form02
args=(sys.stderr,)
[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form01
args=('myapp.log', 'a')
[handler_hand03]
class=handlers.RotatingFileHandler
level=INFO
formatter=form02
args=('myapp.log', 'a', 10*1024*1024, 5)
###############################################
[formatters]
keys=form01,form02
[formatter_form01]
format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s
datefmt=%a, %d %b %Y %H:%M:%S
[formatter_form02]
format=%(name)-12s: %(levelname)-8s %(message)s
datefmt=

獲取logging.config配置的日誌：

import logging
import logging.config

logging.config.fileConfig("logger.conf")
logger = logging.getLogger("example01")

logger.debug("this is debug message")
logger.info('This is info message')
logger.warning('This is warning message')

日誌輸出結果：

example01   : INFO     This is info message
example01   : WARNING  This is warning message

　　

 

 

參考連接1：http://www.cnblogs.com/tkqasn/p/6020282.html

參考連接2：http://www.cnblogs.com/alex3714/articles/5161349.html