Python3之logging模塊


logging的日志可以分為debug(),info(),warning(),error()和critical()5個級別,如果沒有設置,那全局的默認的收錄日志級別是warning。

基本用法

  1: import logging
  2: logging.warning("user [alex] attempted wrong password more than 3 times")
  3: logging.critical("server is down")

輸出

  1: >>> WARNING:root:user [alex] attempted wrong password more than 3 times
  2: CRITICAL:root:server is down

如果想把日志寫到文件里

  1: logging.basicConfig(filename='example.log',level=logging.INFO)
  2: # level=logging.INFO 只收錄比INFO級別高的日志
  3: logging.debug('This message should go to the log file')
  4: logging.info('So should this')
  5: logging.warning('And this, too')

example.log

  1: INFO:root:So should this
  2: WARNING:root:And this, too

自定義日志格式

  1: logging.basicConfig(
  2: filename='example.log',
  3: level=logging.INFO,
  4: format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
  5: logging.warning('is when this event was logged.')

輸出

  1: 12/12/2018 05:05:29 PM is when this event was logged.

下面是所有支持的格式

  1: %(levelno)s	    數字形式的日志級別
  2: %(levelname)s	    文本形式的日志級別
  3: %(pathname)s	    調用日志輸出函數的模塊的完整路徑名,可能沒有
  4: %(filename)s	    調用日志輸出函數的模塊的文件名
  5: %(module)s	    調用日志輸出函數的模塊名
  6: %(funcName)s	    調用日志輸出函數的函數名
  7: %(lineno)d	    調用日志輸出函數的語句所在的代碼行
  8: %(created)f	    當前時間,用UNIX標准的表示時間的浮 點數表示
  9: %(relativeCreated)d	輸出日志信息時的,自Logger創建以 來的毫秒數
 10: %(asctime)s	    字符串形式的當前時間。默認格式是 “2003-07-08 16:49:45,896”。  逗號后面的是毫秒
 11: %(thread)d	    線程ID。可能沒有
 12: %(threadName)s    線程名。可能沒有
 13: %(process)d	    進程ID。可能沒有
 14: %(message)s	    用戶輸出的消息

日志同時輸出到屏幕和文件

Python 使用logging模塊記錄日志涉及四個主要類,使用官方文檔中的概括最為合適:

  1: logger提供了應用程序可以直接使用的接口;
  2: handler將(logger創建的)日志記錄發送到合適的目的輸出;
  3: filter提供了細度設備來決定輸出哪條日志記錄;
  4: formatter決定日志記錄的最終輸出格式。

他們之間的關系用一張圖片表示(stream寫成steam了。懶得改了)

 

logger

每個組件的主要功能如下:

 

logger

每個程序在輸出信息之前都要獲得一個Logger。Logger通常對應了程序的模塊名,比如聊天工具的圖形界面模塊可以這樣獲得它的Logger:

  1: LOG=logging.getLogger("chat.gui")

核心模塊:

  1: LOG=logging.getLogger("chat.kernel")

還可以綁定handler和filters

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可以把信息輸出到控制台,有些Handler可以把信息輸出到文件,還有些 Handler可以把信息發送到網絡上。如果覺得不夠用,還可以編寫自己的Handler。可以通過addHandler()方法添加多個多handler

  1: Handler.setLevel(lel):指定被處理的信息級別,低於lel級別的信息將被忽略
  2: Handler.setFormatter():給這個handler選擇一個格式
  3: Handler.addFilter(filt)、Handler.removeFilter(filt):新增或刪除一個filter對象

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

1.logging.StreamHandler 使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息。

2.logging.FileHandler 和StreamHandler 類似,用於向一個文件輸出日志信息。不過FileHandler會幫你打開這個文件

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,繼續輸出日志信息。它的函數是:

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

其中filename和mode兩個參數和FileHandler一樣。
maxBytes用於指定日志文件的最大文件大小。如果maxBytes為0,意味着日志文件可以無限大,這時上面描述的重命名過程就不會發生。
backupCount用於指定保留的備份文件的個數。比如,如果指定為2,當上面描述的重命名過程發生時,原有的chat.log.2並不會被更名,而是被刪除。

4.logging.handlers.TimedRotatingFileHandler
這個Handler和RotatingFileHandler類似,不過,它沒有通過判斷文件大小來決定何時重新創建日志文件,而是間隔一定時間就 自動創建新的日志文件。重命名的過程與RotatingFileHandler類似,不過新的文件不是附加數字,而是當前時間。它的函數是:

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

其中filename參數和backupCount參數和RotatingFileHandler具有相同的意義。
interval是時間間隔。
when參數是一個字符串。表示時間間隔的單位,不區分大小寫。它有以下取值:
S 秒
M 分
H 小時
D 天
W 每星期(interval==0時代表星期一)
midnight 每天凌晨

 

formatter 組件

日志的formatter是個獨立的組件,可以跟handler組合

  1: fh = logging.FileHandler("access.log")
  2: formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
  3: 
  4: fh.setFormatter(formatter) #把formmater綁定到fh上

 

filter 組件

如果你想對日志內容進行過濾,就可自定義一個filter
class IgnoreBackupLogFilter(logging.Filter):
    """忽略帶db backup 的日志"""
    def filter(self, record): #固定寫法
        return   "db backup" not in record.getMessage()
# 注意filter函數會返加True or False,logger根據此值決定是否輸出此日志

然后把這個filter添加到logger中

  1: logger.addFilter(IgnoreBackupLogFilter())

下面的日志就會把符合filter條件的過濾掉

  1: logger.debug("test ....")
  2: logger.info("test info ....")
  3: logger.warning("start to run db backup job ....")
  4: logger.error("test error ....")

一個不帶filter的簡單的例子

  1: import logging
  2: # 1.生成logger對象,設置日記記錄級別(全局,默認級別為warning,且優先級最高)
  3: logger = logging.getLogger("web")
  4: logger.setLevel(logging.INFO)
  5: 
  6: # 2.生成handler對象,分別設置屏幕打印與文件寫入的日志級別
  7: # 局部級別的設置不能別全局級別的設置低,否則局部設置是沒有效果。
  8: ch = logging.StreamHandler()
  9: ch.setLevel(logging.DEBUG)
 10: fh = logging.FileHandler("web.log")
 11: fh.setLevel(logging.WARNING)
 12: 
 13: # 2.1 把handler對象 綁定到logger
 14: logger.addHandler(ch)
 15: logger.addHandler(fh)
 16: 
 17: # 3.生成formatter對象
 19: file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 20: console_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 21: 
 22: # 3.1 把formatter對象 綁定handler對象
 23: ch.setFormatter(console_formatter)
 24: fh.setFormatter(file_formatter)
 25: 
 26: logger.error("test.log")

 

一個同時輸出到屏幕、文件、帶filter的完成例子

  1: import logging
  2: 
  3: class IgnoreBackupLogFilter(logging.Filter):
  4:     """忽略帶db backup 的日志"""
  5:     def filter(self, record): #固定寫法
  6:         return   "db backup" not in record.getMessage()
  7: 
  8: logger = logging.getLogger("Mysql")
  9: logger.setLevel(logging.DEBUG) 
 10: 
 11: #console handler file handler
 12: ch = logging.StreamHandler()
 13: ch.setLevel(logging.INFO)
 14: fh = logging.FileHandler('mysql.log')
 15: fh.setLevel(logging.WARNING)
 16: 
 17: #formatter
 18: formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 19: #bind formatter to ch
 20: ch.setFormatter(formatter)
 21: fh.setFormatter(formatter)
 22: 
 23: #add handler to logger instance
 24: logger.addHandler(ch)
 25: logger.addHandler(fh)
 26: 
 27: #add filter
 28: logger.addFilter(IgnoreBackupLogFilter())
 29: 
 30: logger.debug("test ....")
 31: logger.info("test info ....")
 32: logger.warning("start to run db backup job ....")
 33: logger.error("test error ....")

日志自動截斷兩種方式

按字節數截斷

  1: fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)

按時間截斷

  1: fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM