[TOC] 程序都有記錄日志的需求，并且日志中包含的信息既有正常的程序訪問日志，還可能有錯誤、警告等信息輸出。 python的logging模塊提供了標準的日志接口，可以通過它存儲各種格式的日志，logging的日志分為`debug(), info(), warning(), error() and critical()`5個級別。 python默認只打印warning級別以上的日志 ## 日志基礎 ### 兩種記錄日志的方式： * 第一種方式是使用logging提供的模塊級別的函數 * 第二種方式是使用Logging日志系統的四大組件 >其實模塊級別的日志記錄函數也是對logging日志系統相關類的封裝。 ### 模塊級別的常用函數 | 函數 | 說明 | | --- | --- | | logging.debug(msg, *args, **kwargs) | 創建一條嚴重級別為DEBUG的日志記錄 | | logging.info(msg, *args, **kwargs) | 創建一條嚴重級別為INFO的日志記錄 | | logging.warning(msg, *args, **kwargs) | 創建一條嚴重級別為WARNING的日志記錄 | | logging.error(msg, *args, **kwargs) | 創建一條嚴重級別為ERROR的日志記錄 | | logging.critical(msg, *args, **kwargs) | 創建一條嚴重級別為CRITICAL的日志記錄 | | logging.log(level, *args, **kwargs) | 創建一條嚴重級別為level的日志記錄 | | logging.basicConfig(**kwargs) | 對root logger進行一次性配置 | >其中`logging.basicConfig(**kwargs)`函數用于指定“要記錄的日志級別”、“日志格式”、“日志輸出位置”、“日志文件的打開模式”等信息，其他幾個都是用于記錄各個級別日志的函數。 ### logging模塊的四大組件 | 組件 | 說明 | | --- | --- | | loggers | 提供應用程序代碼直接使用的接口 | | handlers | 將(logger創建的)日志記錄發送到合適的目的輸出 | | filters | 提供了細度設備來決定輸出哪條日志記錄； | | formatters |決定日志記錄的最終輸出格式 | > logging模塊提供的模塊級別的那些函數實際上也是通過這幾個組件的相關實現類來記錄日志的，只是在創建這些類的實例時設置了一些默認值。 ## 簡單使用 ### 各級別日志演示 默認只有warning級別以上的日志會打印,見案例 ``` >>> import logging >>> logging.debug('the is debug log') >>> logging.info('the is info log') >>> logging.warn('the is warning log') WARNING:root:the is warning log >>> logging.error('the is error log') ERROR:root:the is error log >>> logging.critical('the is critical log') CRITICAL:root:the is critical log >>> logging.log(logging.ERROR,'the is error log 2') ERROR:root:the is error log 2 ``` >每行日志各個字段含義`日志級別:日志器名稱:日志內容` ### 修改最低打印的日志級別 ``` >>> import logging >>> logging.basicConfig(level=logging.INFO) >>> logging.debug('the is debug log') >>> logging.info('the is info log') INFO:root:the is info log ``` > 注意`basicConfig`函數是一次性的配置工具，只有在第一次調用該函數時會起作用 ### 把日志寫到文件 也是用basicConfig方法來修改將日志打印到哪里 ``` >>> import logging >>> logging.basicConfig(filename='tset.log') >>> logging.info('the is info log') >>> logging.warn('the is warning log') >>> logging.error('the is error log') ``` ### basicConfig參數列表 | 參數名稱 | 描述 | | --- | --- | | filename | 指定日志輸出目標文件的文件名 | | filemode | 指定日志文件的打開模式，默認'a'| | format | 指定日志格式字符串 | | datefmt | 指定日期/時間格式,需format中包含%(asctime)s字段 | | level | 指定日志器的日志級別 | | stream | 指定日志輸出目標，如sys.stdout、sys.stderr以及網絡stream。stream和filename不能共存 | | style | 指定format格式字符串的風格，可取值為'%'、'{'和'$'，默認為'%' | | handlers | 該選項如果應該是一個創建了多個Handler的可迭代對象，這些handler將會被添加到root logger。 | > filename、stream和handlers這三個配置項不能共存,否則會引發異常。 ### 自定義日志格式 前面列出了basicConfig的參數,可以根據該參數自定義日志格式 感覺上面的日志格式忘記加上時間啦，日志不知道時間怎么行呢，下面就來加上! ``` >>> import logging >>> logging.basicConfig(format='%(asctime)s %(message)s',datefmt='%Y-%m-%d %I:%M:%S %p') >>> logging.error('the is error log') 2019-01-27 10:44:36 AM the is error log ``` ### format所有參數列表 | 字段/屬性名稱 | 使用格式 | 描述 | | --- | --- | --- | | asctime | %(asctime)s | 字符串形式的當前時間。默認格式是 “2003-07-08 16:49:45,896” | | created | %(created)f | 時間戳，就是調用time.time()函數返回的值 | | msecs | %(msecs)d | 日志發生時間的毫秒部分 | | levelname | %(levelname)s | 文字形式的日志級別 | | levelno | %(levelno)s | 數字形式的日志級別(10, 20, 30, 40, 50) | | name | %(name)s | 使用的日志器名稱，默認是'root' | | message | %(message)s | 日志記錄的文本內容，`msg % args`計算得到的 | | pathname | %(pathname)s | 調用日志記錄函數的源碼文件的全路徑 | | filename | %(filename)s | pathname的文件名部分，含文件后綴 | | module | %(module)s | filename的名稱部分，不包含后綴 | | lineno | %(lineno)d | 調用日志記錄函數的源代碼所在的行號 | | funcName | %(funcName)s | 調用日志記錄函數的函數名 | | process | %(process)d | 進程ID | | processName | %(processName)s | 進程名稱 | | thread | %(thread)d | 線程ID | | threadName | %(thread)s | 線程名稱 | ## 其他說明 ### 幾個要說明的內容： * `logging.basicConfig()`函數是一個一次性的簡單配置工具使，也就是說只有在第一次調用該函數時會起作用，后續再次調用該函數時完全不會產生任何操作的，多次調用的設置并不是累加操作。 * 日志器（Logger）是有層級關系的，上面調用的logging模塊級別的函數所使用的日志器是`RootLogger`類的實例，其名稱為'root'，它是處于日志器層級關系最頂層的日志器，且該實例是以單例模式存在的。 * 如果要記錄的日志中包含變量數據，可使用一個格式字符串作為這個事件的描述消息（logging.debug、logging.info等函數的第一個參數），然后將變量數據作為第二個參數\*args的值進行傳遞，如:`logging.warning('%s is %d years old.', 'Tom', 10)`，輸出內容為`WARNING:root:Tom is 10 years old.` * logging.debug()等方法的定義中，除了msg和args參數外，還有一個**kwargs參數。它們支持3個關鍵字參數:`exc_info, stack_info, extra`，下面對這幾個關鍵字參數作個說明。 ### 關于exc_info, stack_info, extra關鍵詞參數的說明: * **exc_info：** 其值為布爾值，如果該參數的值設置為True，則會將異常信息添加到日志消息中。如果沒有異常信息則添加None到日志信息中。 * **stack\_info：** 其值也為布爾值，默認值為False。如果該參數的值設置為True，棧信息將會被添加到日志信息中。 * **extra：** 這是一個字典（dict）參數，它可以用來自定義消息格式中所包含的字段，但是它的key不能與logging模塊定義的字段沖突。 ### exc_info, stack_info, extra舉例： 在日志消息中添加exc_info和stack_info信息，并添加兩個自定義的字端 ip和user ``` LOG_FORMAT = "%(asctime)s - %(levelname)s - %(user)s[%(ip)s] - %(message)s" DATE_FORMAT = "%m/%d/%Y %H:%M:%S %p" logging.basicConfig(format=LOG_FORMAT, datefmt=DATE_FORMAT) logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'}) ``` 輸出結果： ``` 05/08/2017 16:35:00 PM - WARNING - Tom[47.98.53.222] - Some one delete the log file. NoneType Stack (most recent call last): File "C:/Users/wader/PycharmProjects/LearnPython/day06/log.py", line 45, in <module> logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'}) ```