python logging日誌模組的使用

阿新 • • 發佈：2019-02-06

總結

1 logging 可以記錄異常回溯資訊 traceback.format_exc() 通過loging.exception(msg, args) 或者logging.error(msg,exec_info=true,args) 2 可以定義父類logger, logging.getLogger('main') 後續其他模組如果屬於子模組例如main.sub logging.getLogger('main.sub') 可以直接獲取一個logger 其沿用了父類的配置(檔案路徑，級別）只是模組名稱不一樣 3 可以配置日誌輸出到檔案，控制檯，網路伺服器udp http服務以及日誌回滾方式

4 日誌可以通過配置檔案（json,yaml）初始化（或者程式碼直接初始化）

django 日誌配置https://segmentfault.com/a/1190000003752981

https://www.cnblogs.com/liaocheng/p/5421818.html

https://www.cnblogs.com/i-honey/p/8052579.html

使用工廠方法返回一個Logger例項。

logging.getLogger([name=None])

指定name，返回一個名稱為name的Logger例項。如果再次使用相同的名字，是例項化一個物件。未指定name，返回Logger例項，名稱是root，即根Logger。

1 logging模組簡介

logging模組是Python內建的標準模組，主要用於輸出執行日誌，可以設定輸出日誌的等級、日誌儲存路徑、日誌檔案回滾等；相比print，具備如下優點：

可以通過設定不同的日誌等級，在release版本中只輸出重要資訊，而不必顯示大量的除錯資訊；
print將所有資訊都輸出到標準輸出中，嚴重影響開發者從標準輸出中檢視其它資料；logging則可以由開發者決定將資訊輸出到什麼地方，以及怎麼輸出；

2 logging模組使用

2.1 基本使用

配置logging基本的設定，然後在控制檯輸出日誌，

import logging
logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

執行時，控制檯輸出，

2016-10-09 19:11:19,434 - __main__ - INFO - Start print log
2016-10-09 19:11:19,434 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:11:19,434 - __main__ - INFO - Finish

logging中可以選擇很多訊息級別，如debug、info、warning、error以及critical。通過賦予logger或者handler不同的級別，開發者就可以只輸出錯誤資訊到特定的記錄檔案，或者在除錯時只記錄除錯資訊。

例如，我們將logger的級別改為DEBUG，再觀察一下輸出結果，

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

控制檯輸出，可以發現，輸出了debug的資訊。

2016-10-09 19:12:08,289 - __main__ - INFO - Start print log
2016-10-09 19:12:08,289 - __main__ - DEBUG - Do something
2016-10-09 19:12:08,289 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:12:08,289 - __main__ - INFO - Finish

logging.basicConfig函式各引數：

filename：指定日誌檔名；

filemode：和file函式意義相同，指定日誌檔案的開啟模式，'w'或者'a'；

format：指定輸出的格式和內容，format可以輸出很多有用的資訊，

引數：作用

%(levelno)s：列印日誌級別的數值
%(levelname)s：列印日誌級別的名稱
%(pathname)s：列印當前執行程式的路徑，其實就是sys.argv[0]
%(filename)s：列印當前執行程式名
%(funcName)s：列印日誌的當前函式
%(lineno)d：列印日誌的當前行號
%(asctime)s：列印日誌的時間
%(thread)d：列印執行緒ID
%(threadName)s：列印執行緒名稱
%(process)d：列印程序ID
%(message)s：列印日誌資訊

datefmt：指定時間格式，同time.strftime()；

level：設定日誌級別，預設為logging.WARNNING；

stream：指定將日誌的輸出流，可以指定輸出到sys.stderr，sys.stdout或者檔案，預設輸出到sys.stderr，當stream和filename同時指定時，stream被忽略；

2.2 將日誌寫入到檔案

2.2.1 將日誌寫入到檔案

設定logging，建立一個FileHandler，並對輸出訊息的格式進行設定，將其新增到logger，然後將日誌寫入到指定的檔案中，

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

log.txt中日誌資料為，

2016-10-09 19:01:13,263 - __main__ - INFO - Start print log
2016-10-09 19:01:13,263 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:01:13,263 - __main__ - INFO - Finish

2.2.2 將日誌同時輸出到螢幕和日誌檔案

logger中新增StreamHandler，可以將日誌輸出到螢幕上，

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

可以在log.txt檔案和控制檯中看到，

2016-10-09 19:20:46,553 - __main__ - INFO - Start print log
2016-10-09 19:20:46,553 - __main__ - WARNING - Something maybe fail.
2016-10-09 19:20:46,553 - __main__ - INFO - Finish

可以發現，logging有一個日誌處理的主物件，其他處理方式都是通過addHandler新增進去，logging中包含的handler主要有如下幾種，

handler名稱：位置；作用

StreamHandler：logging.StreamHandler；日誌輸出到流，可以是sys.stderr，sys.stdout或者檔案
FileHandler：logging.FileHandler；日誌輸出到檔案
BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日誌回滾方式
RotatingHandler：logging.handlers.RotatingHandler；日誌回滾方式，支援日誌檔案最大數量和日誌檔案回滾
TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日誌回滾方式，在一定時間區域內回滾日誌檔案
SocketHandler：logging.handlers.SocketHandler；遠端輸出日誌到TCP/IP sockets
DatagramHandler：logging.handlers.DatagramHandler；遠端輸出日誌到UDP sockets
SMTPHandler：logging.handlers.SMTPHandler；遠端輸出日誌到郵件地址
SysLogHandler：logging.handlers.SysLogHandler；日誌輸出到syslog
NTEventLogHandler：logging.handlers.NTEventLogHandler；遠端輸出日誌到Windows NT/2000/XP的事件日誌
MemoryHandler：logging.handlers.MemoryHandler；日誌輸出到記憶體中的指定buffer
HTTPHandler：logging.handlers.HTTPHandler；通過"GET"或者"POST"遠端輸出到HTTP伺服器

2.2.3 日誌回滾

使用RotatingFileHandler，可以實現日誌回滾，

import logging
from logging.handlers import RotatingFileHandler
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
#定義一個RotatingFileHandler，最多備份3個日誌檔案，每個日誌檔案最大1K
rHandler = RotatingFileHandler("log.txt",maxBytes = 1*1024,backupCount = 3)
rHandler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
rHandler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(rHandler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

可以在工程目錄中看到，備份的日誌檔案，

2016/10/09  19:36               732 log.txt
2016/10/09  19:36               967 log.txt.1
2016/10/09  19:36               985 log.txt.2
2016/10/09  19:36               976 log.txt.3

2.3 設定訊息的等級

可以設定不同的日誌等級，用於控制日誌的輸出，

日誌等級：使用範圍

FATAL：致命錯誤
CRITICAL：特別糟糕的事情，如記憶體耗盡、磁碟空間為空，一般很少使用
ERROR：發生錯誤時，如IO操作失敗或者連線問題
WARNING：發生很重要的事件，但是並不是錯誤時，如使用者登入密碼錯誤
INFO：處理請求或者狀態變化等日常事務
DEBUG：除錯過程中使用DEBUG等級，如演算法中每個迴圈的中間狀態

2.4 捕獲traceback

Python中的traceback模組被用於跟蹤異常返回資訊，可以在logging中記錄下traceback，

程式碼，

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
try:
    open("sklearn.txt","rb")
except (SystemExit,KeyboardInterrupt):
    raise
except Exception:
    logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

logger.info("Finish")

控制檯和日誌檔案log.txt中輸出，

Start print log
Something maybe fail.
Faild to open sklearn.txt from logger.error
Traceback (most recent call last):
  File "G:\zhb7627\Code\Eclipse WorkSpace\PythonTest\test.py", line 23, in <module>
    open("sklearn.txt","rb")
IOError: [Errno 2] No such file or directory: 'sklearn.txt'
Finish

也可以使用logger.exception(msg,_args)，它等價於logger.error(msg,exc_info = True,_args)，

將

logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

替換為，

logger.exception("Failed to open sklearn.txt from logger.exception")

控制檯和日誌檔案log.txt中輸出，

Start print log
Something maybe fail.
Failed to open sklearn.txt from logger.exception
Traceback (most recent call last):
  File "G:\zhb7627\Code\Eclipse WorkSpace\PythonTest\test.py", line 23, in <module>
    open("sklearn.txt","rb")
IOError: [Errno 2] No such file or directory: 'sklearn.txt'
Finish

2.5 多模組使用logging

主模組mainModule.py，

import logging
import subModule
logger = logging.getLogger("mainModule")
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)


logger.info("creating an instance of subModule.subModuleClass")
a = subModule.SubModuleClass()
logger.info("calling subModule.subModuleClass.doSomething")
a.doSomething()
logger.info("done with  subModule.subModuleClass.doSomething")
logger.info("calling subModule.some_function")
subModule.som_function()
logger.info("done with subModule.some_function")

子模組subModule.py，

import logging

module_logger = logging.getLogger("mainModule.sub")
class SubModuleClass(object):
    def __init__(self):
        self.logger = logging.getLogger("mainModule.sub.module")
        self.logger.info("creating an instance in SubModuleClass")
    def doSomething(self):
        self.logger.info("do something in SubModule")
        a = []
        a.append(1)
        self.logger.debug("list a = " + str(a))
        self.logger.info("finish something in SubModuleClass")

def som_function():
    module_logger.info("call function some_function")

執行之後，在控制和日誌檔案log.txt中輸出，

2016-10-09 20:25:42,276 - mainModule - INFO - creating an instance of subModule.subModuleClass
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - creating an instance in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - do something in SubModule
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - finish something in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - done with  subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.some_function
2016-10-09 20:25:42,279 - mainModule.sub - INFO - call function some_function
2016-10-09 20:25:42,279 - mainModule - INFO - done with subModule.some_function

首先在主模組定義了logger'mainModule'，並對它進行了配置，就可以在直譯器程序裡面的其他地方通過getLogger('mainModule')得到的物件都是一樣的，不需要重新配置，可以直接使用。定義的該logger的子logger，都可以共享父logger的定義和配置，所謂的父子logger是通過命名來識別，任意以'mainModule'開頭的logger都是它的子logger，例如'mainModule.sub'。

實際開發一個application，首先可以通過logging配置檔案編寫好這個application所對應的配置，可以生成一個根logger，如'PythonAPP'，然後在主函式中通過fileConfig載入logging配置，接著在application的其他地方、不同的模組中，可以使用根logger的子logger，如'PythonAPP.Core'，'PythonAPP.Web'來進行log，而不需要反覆的定義和配置各個模組的logger。

3 通過JSON或者YAML檔案配置logging模組

儘管可以在Python程式碼中配置logging，但是這樣並不夠靈活，最好的方法是使用一個配置檔案來配置。在Python 2.7及以後的版本中，可以從字典中載入logging配置，也就意味著可以通過JSON或者YAML檔案載入日誌的配置。

3.1 通過JSON檔案配置

JSON配置檔案，

{
    "version":1,
    "disable_existing_loggers":false,
    "formatters":{
        "simple":{
            "format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        }
    },
    "handlers":{
        "console":{
            "class":"logging.StreamHandler",
            "level":"DEBUG",
            "formatter":"simple",
            "stream":"ext://sys.stdout"
        },
        "info_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"INFO",
            "formatter":"simple",
            "filename":"info.log",
            "maxBytes":"10485760",
            "backupCount":20,
            "encoding":"utf8"
        },
        "error_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"ERROR",
            "formatter":"simple",
            "filename":"errors.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        }
    },
    "loggers":{
        "my_module":{
            "level":"ERROR",
            "handlers":["info_file_handler"],
            "propagate":"no"
        }
    },
    "root":{
        "level":"INFO",
        "handlers":["console","info_file_handler","error_file_handler"]
    }
}

通過JSON載入配置檔案，然後通過logging.dictConfig配置logging，

import json
import logging.config
import os

def setup_logging(default_path = "logging.json",default_level = logging.INFO,env_key = "LOG_CFG"):
    path = default_path
    value = os.getenv(env_key,None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path,"r") as f:
            config = json.load(f)
            logging.config.dictConfig(config)
    else:
        logging.basicConfig(level = default_level)

def func():
    logging.info("start func")

    logging.info("exec func")

    logging.info("end func")

if __name__ == "__main__":
    setup_logging(default_path = "logging.json")
    func()

python logging日誌模組的使用

總結

1 logging模組簡介

2 logging模組使用

2.1 基本使用

2.2 將日誌寫入到檔案

2.3 設定訊息的等級

2.4 捕獲traceback

2.5 多模組使用logging

3 通過JSON或者YAML檔案配置logging模組

3.1 通過JSON檔案配置

3.2 通過YAML檔

Python logging日誌模組

python logging日誌模組以及多程序日誌

python logging日誌模組的使用

【python】詳解logging日誌模組

Python 中 logging 日誌模組在多程序環境下的使用

python-25 logging日誌模組之二

【python介面自動化】- logging日誌模組

python logging 日誌使用

python logging 日誌輪轉文件不刪除問題的解決方法

python--logging日誌

logging日誌模組，re正則表示式模組，hashlib hash演算法相關的庫，

logging日誌模組，四種方式

python logging日誌記錄

python logging 日誌

python logging 日誌輸出學習筆記時間格式化

Appium-python日誌模組logging（1）

Python--day29--logging模組(日誌模組)

python-logging模組的簡單使用：如何同時輸出到控制檯和本地日誌檔案

python日誌模組---logging

自學Python--日誌模組logging

python logging日誌模組的使用

總結

1 logging模組簡介

2 logging模組使用

2.1 基本使用

2.2 將日誌寫入到檔案

2.3 設定訊息的等級

2.4 捕獲traceback

2.5 多模組使用logging

3 通過JSON或者YAML檔案配置logging模組

3.1 通過JSON檔案配置

3.2 通過YAML檔

相關推薦