python 日志模塊logging的使用場景及示例

Posted on by

前言

日志是對於軟件執行所發生的事件的一種追蹤記錄方式。日常使用過程中對代碼執行的錯誤和問題會進行查看日志來分析定位問題所在。平常編寫代碼以及調試也經常用到。通常的新手的做法是直接print打印，但是打印的結果隻在控制臺顯示。今天我們學習一種高級的日志打印和記錄模塊logging。

logging提供瞭一系列的函數，它們是debug(), info(), warning(), error(), 和critical()。

他們的使用場景請看下表

你想要執行的任務 此任務的最好的工具
對於命令行或程序的應用，結果顯示在控制臺。 print()
在對程序的普通操作發生時提交事件報告(比如：狀態監控和錯誤調查) logging.info() 函數(當有診斷目的需要詳細輸出信息時使用 logging.debug() 函數)
提出一個警告信息基於一個特殊的運行時事件 warnings.warn()位於代碼庫中，該事件是可以避免的，需要修改客戶端應用以消除告警logging.warning() 不需要修改客戶端應用，但是該事件還是需要引起關註
對一個特殊的運行時事件報告錯誤 引發異常
報告錯誤而不引發異常(如在長時間運行中的服務端進程的錯誤處理) logging.error(), logging.exception() 或 logging.critical()分別適用於特定的錯誤及應用領域

日志功能分別對各種事件和嚴重性都進行分級。

名稱 何時使用 等級
DEBUG 細節信息，僅當診斷問題時適用。 10
INFO 確認程序按預期運行 20
WARNING 表明有已經或即將發生的意外（例如：磁盤空間不足）。程序仍按預期進行 30
ERROR 由於嚴重的問題，程序的某些功能已經不能正常執行 40
CRITICAL 嚴重的錯誤，表明程序已不能繼續執行 50

示例

簡單示例

因為是python自帶的所以無需安裝，默認的級別是WARNING，所以下面隻顯示一條warning信息。

import logging
logging.warning('this is warning')
logging.info('this is info')

更改級別

我們將默認的級別改成最低級別，則會打印同級別以及高級別的日志信息

import logging 
logging.basicConfig(level=logging.DEBUG)
logging.debug('this is debug')
logging.info('this is info')
logging.warning('this is warning')
logging.error('this is error')

保存日志

隻是打印到控制臺對於少量信息倒是可控，但是信息量大的時候就不方便查找瞭。那麼我們需要將其保存到文件中。

import logging 
logging.basicConfig(level=logging.DEBUG,filename='log.log',format='%(asctime)s - %(lineno)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)
logger.debug('this is debug')
logger.info('this is info')
logger.warning('this is warning')
logger.error('this is error')

上面我們在保存的時候，同時還添加瞭其他描述信息，比如執行時間，執行代碼行數，日志級別，打印消息。當然方法遠不止這些，具體請看下表

屬性名稱 格式 描述
ARGS 你不需要自己設置格式。 參數元組被合並到msg中以產生消息，或者其值被用於合並的詞典（當隻有一個參數時，它是一個字典）。
asctime ％（asctime）類 創建時的可讀時間。默認情況下，這是’2003-07-08 16：49：45,896’的格式（逗號之後的數字是毫秒部分）。
created ％（created）的F 創建的時間（由time.time（）返回）。
exc_info 你不需要自己設置格式。 異常元組（àla sys.exc_info）或，如果沒有發生異常，則為無。
filename ％（filename）類 路徑名的文件名部分。
funcName ％（funcName）類 包含日志記錄調用的函數的名稱。
levelname ％（levelname）■ 文本消息級別（’DEBUG’，’INFO’，’WARNING’，’ERROR’，’CRITICAL’）。
levelno ％（levelno）s 消息的數字記錄級別（DEBUG，INFO，WARNING，ERROR，CRITICAL）。
lineno ％（lineno）d 發出日志記錄調用的源行號。
module ％（module）類 模塊（文件名稱部分）。
msecs ％（msecs）d 創建時的毫秒部分。
message ％（message）類 記錄的消息，計算為msg％args。這是在調用Formatter.format（）時設置的。
msg 你不需要自己設置格式。 在原始日志記錄調用中傳遞的格式字符串。與args合並生成消息或任意對象（請參閱使用任意對象作為消息）。
name ％（name）類 用於記錄呼叫的記錄器的名稱。
pathname ％（filename）類 發出日志記錄調用的源文件的完整路徑名。
process ％（process）d 進程ID。
processName ％（processName）類 進程名稱。
relativeCreated ％（relativeCreated）d 相對於加載日志記錄模塊的時間，LogRecord創建時的時間（以毫秒為單位）。
thread ％（thread）d 線程ID。
threadName ％（threadName）類 線程名稱。

日志輸出進階

首先瞭解以下進階的方法的說明：

StreamHandler 類位於核心 logging 包，它可將日志記錄輸出發送到數據流例如 sys.stdout, sys.stderr 或任何文件類對象（或者更精確地說，任何支持 write() 和 flush() 方法的對象

FileHandler 類位於核心 logging 包，它可將日志記錄輸出到磁盤文件中。 它從 StreamHandler 繼承瞭輸出功能。

我們需要通過調用 Logger 類（以下稱為 loggers ， 記錄器）的實例來執行日志記錄。

Logger 對象有三個常見的方法：

  • Logger.setLevel() 指定記錄器將處理的最低嚴重性日志消息，其中 debug 是最低內置嚴重性級別， critical 是最高內置嚴重性級別。 例如，如果嚴重性級別為 INFO ，則記錄器將僅處理 INFO 、 WARNING 、 ERROR 和 CRITICAL 消息，並將忽略 DEBUG 消息。
  • Logger.addHandler() 和 Logger.removeHandler() 從記錄器對象中添加和刪除處理程序對象。處理程序在以下內容中有更詳細的介紹 處理程序 。
  • Logger.addFilter() 和 Logger.removeFilter() 可以添加或移除記錄器對象中的過濾器。 Filter 對象 包含更多的過濾器細節。

下面示例采用添加日志記錄器對象輸出和上面一樣在控制臺打印

import logging
 
logger = logging.getLogger(__name__)
logger.setLevel(level=logging.INFO)
handler = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s - %(lineno)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
 
logger.info('This is a log info')
logger.debug('Debugging')
logger.warning('Warning exists')
logger.info('Finish')

當然也同樣能保存到文件，為瞭演示修改瞭文件名稱為put.log

import logging
 
logger = logging.getLogger(__name__)
logger.setLevel(level=logging.INFO)
handler = logging.FileHandler('put.log')
formatter = logging.Formatter('%(asctime)s - %(lineno)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
 
 
logger.info('This is a log info')
logger.debug('Debugging')
logger.warning('Warning exists')
logger.info('Finish')

日志雙向輸出

import logging

logger = logging.getLogger(__name__)
logger.setLevel(level=logging.INFO)
handler1 = logging.FileHandler('output.log')
handler2 = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s - %(lineno)s - %(levelname)s - %(message)s')
handler1.setFormatter(formatter)
handler2.setFormatter(formatter)
logger.addHandler(handler1)
logger.addHandler(handler2)

logger.info('This is a log info')
logger.debug('Debugging')
logger.warning('Warning exists')
logger.info('Finish')

以上就是python 日志模塊logging的使用場景及示例的詳細內容，更多關於python 日志模塊logging的使用的資料請關註WalkonNet其它相關文章！

推薦閱讀：