python之配置日誌的幾種方式

本篇文章主要介紹了詳解python之配置日誌的幾種方式，現在分享給大家，也給大家做個參考。一起過來看看吧

作為開發人員，我們可以通過以下3中方式來配置logging:

1）使用Python代碼顯式的建立loggers, handlers和formatters並分別調用它們的配置函數；

2）建立一個日誌設定檔，然後使用fileConfig()函數來讀取該檔案的內容；

3）建立一個包含配置資訊的dict，然後把它傳遞個dictConfig()函數；

需要說明的是，logging.basicConfig()也屬於第一種方式，它只是對loggers, handlers和formatters的配置函數進行了封裝。另外，第二種配置方式相對於第一種配置方式的優點在於，它將配置資訊和代碼進行了分離，這一方面降低了日誌的維護成本，同時還使得非開發人員也能夠去很容易地修改日誌配置。

一、使用Python代碼實現日誌配置

代碼如下：

# 建立一個日誌器logger並設定其記錄層級為DEBUGlogger = logging.getLogger('simple_logger')logger.setLevel(logging.DEBUG)# 建立一個流處理器handler並設定其記錄層級為DEBUGhandler = logging.StreamHandler(sys.stdout)handler.setLevel(logging.DEBUG)# 建立一個格式器formatter並將其添加到處理器handlerformatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")handler.setFormatter(formatter)# 為日誌器logger添加上面建立的處理器handlerlogger.addHandler(handler)# 日誌輸出logger.debug('debug message')logger.info('info message')logger.warn('warn message')logger.error('error message')logger.critical('critical message')

運行輸出：

2017-05-15 11:30:50,955 - simple_logger - DEBUG - debug message2017-05-15 11:30:50,955 - simple_logger - INFO - info message2017-05-15 11:30:50,955 - simple_logger - WARNING - warn message2017-05-15 11:30:50,955 - simple_logger - ERROR - error message2017-05-15 11:30:50,955 - simple_logger - CRITICAL - critical message

二、使用設定檔和fileConfig()函數實現日誌配置

現在我們通過設定檔的方式來實現與上面同樣的功能：

# 讀取日誌設定檔內容logging.config.fileConfig('logging.conf')# 建立一個日誌器loggerlogger = logging.getLogger('simpleExample')# 日誌輸出logger.debug('debug message')logger.info('info message')logger.warn('warn message')logger.error('error message')logger.critical('critical message')

設定檔logging.conf內容如下：

[loggers]keys=root,simpleExample[handlers]keys=fileHandler,consoleHandler[formatters]keys=simpleFormatter[logger_root]level=DEBUGhandlers=fileHandler[logger_simpleExample]level=DEBUGhandlers=consoleHandlerqualname=simpleExamplepropagate=0[handler_consoleHandler]class=StreamHandlerargs=(sys.stdout,)level=DEBUGformatter=simpleFormatter[handler_fileHandler]class=FileHandlerargs=('logging.log', 'a')level=ERRORformatter=simpleFormatter[formatter_simpleFormatter]format=%(asctime)s - %(name)s - %(levelname)s - %(message)sdatefmt=

運行輸出：

2017-05-15 11:32:16,539 - simpleExample - DEBUG - debug message2017-05-15 11:32:16,555 - simpleExample - INFO - info message2017-05-15 11:32:16,555 - simpleExample - WARNING - warn message2017-05-15 11:32:16,555 - simpleExample - ERROR - error message2017-05-15 11:32:16,555 - simpleExample - CRITICAL - critical message

1. 關於fileConfig()函數的說明：

該函數實際上是對configparser模組的封裝，關於configparser模組的介紹請參考<。

函數定義：

該函數定義在loging.config模組下：

複製代碼 代碼如下:

logging.config.fileConfig(fname, defaults=None, disable_existing_loggers=True)

參數：

1. fname：表示設定檔的檔案名稱或檔案對象

2. defaults：指定傳給ConfigParser的預設值

3. disable_existing_loggers：這是一個布爾型值，預設值為True（為了向後相容）表示禁用已經存在的logger，除非它們或者它們的祖先明確的出現在日誌配置中；如果值為False則對已存在的loggers保持啟動狀態。

2. 設定檔格式說明：

上面提到過，fileConfig()函數是對ConfigParser/configparser模組的封裝，也就是說fileConfig()函數是基於ConfigParser/configparser模組來理解日誌設定檔的。換句話說，fileConfig()函數所能理解的設定檔基礎格式是與ConfigParser/configparser模組一致的，只是在此基礎上對檔案中包含的section和option做了一下規定和限制，比如：

1）設定檔中一定要包含loggers、handlers、formatters這些section，它們通過keys這個option來指定該設定檔中已經定義好的loggers、handlers和formatters，多個值之間用逗號分隔；另外loggers這個section中的keys一定要包含root這個值；

2）loggers、handlers、formatters中所指定的日誌器、處理器和格式器都需要在下面以單獨的section進行定義。seciton的命名規則為[logger_loggerName]、[formatter_formatterName]、[handler_handlerName]

3）定義logger的section必須指定level和handlers這兩個option，level的可取值為DEBUG、INFO、WARNING、ERROR、CRITICAL、NOTSET，其中NOTSET表示所有層級的日誌訊息都要記錄，包括使用者定義層級；handlers的值是以逗號分隔的handler名字列表，這裡出現的handler必須出現在[handlers]這個section中，並且相應的handler必須在設定檔中有對應的section定義；

4）對於非root logger來說，除了level和handlers這兩個option之外，還需要一些額外的option，其中qualname是必須提供的option，它表示在logger層級中的名字，在應用代碼中通過這個名字得到logger；propagate是可選項，其預設是為1，表示訊息將會傳遞給高層次logger的handler，通常我們需要指定其值為0，這個可以看下下面的例子；另外，對於非root logger的level如果設定為NOTSET，系統將會尋找高層次的logger來決定此logger的有效level。

5）定義handler的section中必須指定class和args這兩個option，level和formatter為可選option；class表示用於建立handler的類名，args表示傳遞給class所指定的handler類初始化方法參數，它必須是一個元組（tuple）的形式，即便只有一個參數值也需要是一個元組的形式；level與logger中的level一樣，而formatter指定的是該處理器所使用的格式器，這裡指定的格式器名稱必須出現在formatters這個section中，且在設定檔中必須要有這個formatter的section定義；如果不指定formatter則該handler將會以訊息本身作為日誌訊息進行記錄，而不添加額外的時間、日誌器名稱等資訊；

6）定義formatter的sectioin中的option都是可選的，其中包括format用於指定格式字串，預設為訊息字串本身；datefmt用於指定asctime的時間格式，預設為'%Y-%m-%d %H:%M:%S'；class用於指定格式器類名，預設為logging.Formatter；

說明：

設定檔中的class指定類名時，該類名可以是相對於logging模組的相對值，如：FileHandler、handlers.TimeRotatingFileHandler；也可以是一個絕對路徑值，通過普通的import機制來解析，如自訂的handler類mypackage.mymodule.MyHandler，但是mypackage需要在Python可用的匯入路徑中--sys.path。

3. 對於propagate屬性的說明

執行個體1：

我們把logging.conf中simpleExample這個handler定義中的propagate屬性值改為1，或者刪除這個option（預設值就是1）：

[logger_simpleExample]level=DEBUGhandlers=consoleHandlerqualname=simpleExamplepropagate=1

現在來執行同樣的代碼：

# 讀取日誌設定檔內容logging.config.fileConfig('logging.conf')# 建立一個日誌器loggerlogger = logging.getLogger('simpleExample')# 日誌輸出logger.debug('debug message')logger.info('info message')logger.warn('warn message')logger.error('error message')logger.critical('critical message')

我們會發現，除了在控制台有輸出資訊時候，在logging.log檔案中也有內容輸出:

2017-05-15 16:06:25,366 - simpleExample - ERROR - error message2017-05-15 16:06:25,367 - simpleExample - CRITICAL - critical message

這說明simpleExample這個logger在處理完日誌記錄後，把日誌記錄傳遞給了上級的root logger再次做處理，所有才會有兩個地方都有日誌記錄的輸出。通常，我們都需要顯示的指定propagate的值為0，防止日誌記錄向上層logger傳遞。

執行個體2：

現在，我們試著用一個沒有在設定檔中定義的logger名稱來擷取logger：

# 讀取日誌設定檔內容logging.config.fileConfig('logging.conf')# 用一個沒有在設定檔中定義的logger名稱來建立一個日誌器loggerlogger = logging.getLogger('simpleExample1')# 日誌輸出logger.debug('debug message')logger.info('info message')logger.warn('warn message')logger.error('error message')logger.critical('critical message')

運行程式後，我們會發現控制台沒有任何輸出，而logging.log檔案中又多了兩行輸出：

2017-05-15 16:13:16,810 - simpleExample1 - ERROR - error message2017-05-15 16:13:16,810 - simpleExample1 - CRITICAL - critical message

這是因為，當一個日誌器沒有被設定任何處理器是，系統會去尋找該日誌器的上層日誌器上所設定的Tlog器來處理日誌記錄。simpleExample1在設定檔中沒有被定義，因此logging.getLogger(simpleExample1)這行代碼這是擷取了一個logger執行個體，並沒有給它設定任何處理器，但是它的上級日誌器--root logger在設定檔中有定義且設定了一個FileHandler處理器，simpleExample1處理器最終通過這個FileHandler處理器將日誌記錄輸出到logging.log檔案中了。

三、使用字典配置資訊和dictConfig()函數實現日誌配置

Python 3.2中引入的一種新的配置日誌記錄的方法--用字典來儲存logging配置資訊。這相對於上面所講的基於設定檔來儲存logging配置資訊的方式來說，功能更加強大，也更加靈活，因為我們可把很多的資料轉換成字典。比如，我們可以使用JSON格式的設定檔、YAML格式的設定檔，然後將它們填充到一個配置字典中；或者，我們也可以用Python代碼構建這個配置字典，或者通過socket接收pickled序列化後的配置資訊。總之，你可以使用你的應用程式可以操作的任何方法來構建這個配置字典。

這個例子中，我們將使用YAML格式來完成與上面同樣的日誌配置。

首先需要安裝PyYAML模組：

pip install PyYAML

Python代碼：

import loggingimport logging.configimport yamlwith open('logging.yml', 'r') as f_conf:  dict_conf = yaml.load(f_conf)logging.config.dictConfig(dict_conf)logger = logging.getLogger('simpleExample')logger.debug('debug message')logger.info('info message')logger.warn('warn message')logger.error('error message')logger.critical('critical message')logging.yml設定檔的內容：version: 1formatters: simple:  format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'handlers: console:  class: logging.StreamHandler  level: DEBUG  formatter: simple  stream: ext://sys.stdout console_err:  class: logging.StreamHandler  level: ERROR  formatter: simple  stream: ext://sys.stderrloggers: simpleExample:  level: DEBUG  handlers: [console]  propagate: yesroot: level: DEBUG handlers: [console_err]

輸出結果：

2017-05-21 14:19:31,089 - simpleExample - DEBUG - debug message2017-05-21 14:19:31,089 - simpleExample - INFO - info message2017-05-21 14:19:31,089 - simpleExample - WARNING - warn message2017-05-21 14:19:31,089 - simpleExample - ERROR - error message2017-05-21 14:19:31,090 - simpleExample - CRITICAL - critical message

1. 關於dictConfig()函數的說明：

該函數實際上是對configparser模組的封裝。

函數定義：

該函數定義在loging.config模組下：

logging.config.dictConfig(config)

該函數可以從一個字典對象中擷取日誌配置資訊，config參數就是這個字典對象。關於這個字典對象的內容規則會在下面進行描述。

2. 配置字典說明

無論是上面提到的設定檔，還是這裡的配置字典，它們都要描述出日誌配置所需要建立的各種對象以及這些對象之間的關聯關係。比如，可以先建立一個名額為“simple”的格式器formatter；然後建立一個名為“console”的處理器handler，並指定該handler輸出日誌所使用的格式器為"simple"；然後再建立一個日誌器logger，並指定它所使用的處理器為"console"。

傳遞給dictConfig()函數的字典對象只能包含下面這些keys，其中version是必須指定的key，其它key都是可選項：

key名稱	描述
version	必選項，其值是一個整數值，表示配置格式的版本，當前唯一可用的值就是1
formatters	可選項，其值是一個字典對象，該字典對象每個元素的key為要定義的格式器名稱，value為格式器的配置資訊組成的dict，如format和datefmt
filters	可選項，其值是一個字典對象，該字典對象每個元素的key為要定義的過濾器名稱，value為過濾器的配置資訊組成的dict，如name
handlers	可選項，其值是一個字典對象，該字典對象每個元素的key為要定義的處理器名稱，value為處理器的配置資訊組成的dcit，如class、level、formatter和filters，其中class為必選項，其它為可選項；其他配置資訊將會傳遞給class所指定的處理器類的建構函式，如下面的handlers定義樣本中的stream、filename、maxBytes和backupCount等
loggers	可選項，其值是一個字典對象，該字典對象每個元素的key為要定義的日誌器名稱，value為日誌器的配置資訊組成的dcit，如level、handlers、filters 和 propagate（yes
root	可選項，這是root logger的配置資訊，其值也是一個字典對象。除非在定義其它logger時明確指定propagate值為no，否則root logger定義的handlers都會被作用到其它logger上
incremental	可選項，預設值為False。該選項的意義在於，如果這裡定義的對象已經存在，那麼這裡對這些對象的定義是否應用到已存在的對象上。值為False表示，已存在的對象將會被重新定義。
disable_existing_loggers	可選項，預設值為True。該選項用於指定是否禁用已存在的日誌器loggers，如果incremental的值為True則該選項將會被忽略

handlers定義樣本：

handlers: console:  class : logging.StreamHandler  formatter: brief  level  : INFO  filters: [allow_foo]  stream : ext://sys.stdout file:  class : logging.handlers.RotatingFileHandler  formatter: precise  filename: logconfig.log  maxBytes: 1024  backupCount: 3

3. 關於外部對象的訪問

需要說明的是，上面所使用的對象並不限於loggging模組所提供的對象，我們可以實現自己的formatter或handler類。另外，這些類的參數也許需要包含sys.stderr這樣的外部對象。如果配置字典對象是使用Python代碼構造的，可以直接使用sys.stdout、sys.stderr；但是當通過文字檔（如JSON、YAML格式的設定檔）提供配置時就會出現問題，因為在文字檔中，沒有標準的方法來區分sys.stderr和字串 'sys.stderr'。為了區分它們，配置系統會在字串值中尋找特定的首碼，例如'ext://sys.stderr'中'ext://'會被移除，然後import sys.stderr。