除了傳遞給日志記錄函數的參數（如msg）外，有時候我們還想在日志輸出中包含一些額外的上下文信息。比如，在一個網絡應用中，可能希望在日志中記錄客戶端的特定信息，如：遠程客戶端的IP地址和用戶名。這里我們來介紹以下幾種實現方式：

• 通過向日志記錄函數傳遞一個extra參數引入上下文信息
• 使用LoggerAdapters引入上下文信息
• 使用Filters引入上下文信息

一、通過向日志記錄函數傳遞一個extra參數引入上下文信息

---

前面我們提到過，可以通過向日志記錄函數傳遞一個extra參數來實現向日志輸出中添加額外的上下文信息，如：

import logging
import sysfmt = logging.Formatter("%(asctime)s - %(name)s - %(ip)s - %(username)s - %(message)s")
h_console = logging.StreamHandler(sys.stdout)
h_console.setFormatter(fmt)
logger = logging.getLogger("myPro")
logger.setLevel(logging.DEBUG)
logger.addHandler(h_console)extra_dict = {"ip": "113.208.78.29", "username": "Petter"}
logger.debug("User Login!", extra=extra_dict)extra_dict = {"ip": "223.190.65.139", "username": "Jerry"}
logger.info("User Access!", extra=extra_dict)

輸出：

2017-05-14 15:47:25,562 - myPro - 113.208.78.29 - Petter - User Login!
2017-05-14 15:47:25,562 - myPro - 223.190.65.139 - Jerry - User Access!

但是用這種方式來傳遞信息并不是那么方便，因為每次調用日志記錄方法都要傳遞一個extra關鍵詞參數。即便沒有需要插入的上下文信息也是如此，因為該logger設置的formatter格式中指定的字段必須要存在。所以，我們推薦使用下面兩種方式來實現上下文信息的引入。

也許可以嘗試創建許多不同的Logger實例來解決上面存在的問題，但是這顯然不是一個好的解決方案，因為這些Logger實例并不會進行垃圾回收。盡管這在實踐中不是個問題，但是當Logger數量變得不可控將會非常難以管理。

二、使用LoggerAdapters引入上下文信息

---

使用LoggerAdapter類來傳遞上下文信息到日志事件的信息中是一個非常簡單的方式，可以把它看做第一種實現方式的優化版--因為它為extra提供了一個默認值。這個類設計的類似于Logger，因此我們可以像使用Logger類的實例那樣來調用debug(), info(), warning(),error(), exception(), critical()和log()方法。當創建一個LoggerAdapter的實例時，我們需要傳遞一個Logger實例和一個包含上下文信息的類字典對象給該類的實例構建方法。當調用LoggerAdapter實例的一個日志記錄方法時，該方法會在對日志日志消息和字典對象進行處理后，調用構建該實例時傳遞給該實例的logger對象的同名的日志記錄方法。下面是LoggerAdapter類中幾個方法的定義：

class LoggerAdapter(object):"""An adapter for loggers which makes it easier to specify contextualinformation in logging output."""def __init__(self, logger, extra):"""Initialize the adapter with a logger and a dict-like object whichprovides contextual information. This constructor signature allowseasy stacking of LoggerAdapters, if so desired.You can effectively pass keyword arguments as shown in thefollowing example:adapter = LoggerAdapter(someLogger, dict(p1=v1, p2="v2"))"""self.logger = loggerself.extra = extradef process(self, msg, kwargs):"""Process the logging message and keyword arguments passed in toa logging call to insert contextual information. You can eithermanipulate the message itself, the keyword args or both. Returnthe message and kwargs modified (or not) to suit your needs.Normally, you'll only need to override this one method in aLoggerAdapter subclass for your specific needs."""kwargs["extra"] = self.extrareturn msg, kwargsdef debug(self, msg, *args, **kwargs):"""Delegate a debug call to the underlying logger, after addingcontextual information from this adapter instance."""msg, kwargs = self.process(msg, kwargs)self.logger.debug(msg, *args, **kwargs)

通過分析上面的代碼可以得出以下結論：

• 上下文信息是在LoggerAdapter類的process()方法中被添加到日志記錄的輸出消息中的，如果要實現自定義需求只需要實現LoggerAdapter的子類并重寫process()方法即可；
• process()方法的默認實現中，沒有修改msg的值，只是為關鍵詞參數插入了一個名為extra的 key，這個extra的值為傳遞給LoggerAdapter類構造方法的參數值；
• LoggerAdapter類構建方法所接收的extra參數，實際上就是為了滿足logger的formatter格式要求所提供的默認上下文信息。

關于上面提到的第3個結論，我們來看個例子：

import logging
import sys# 初始化一個要傳遞給LoggerAdapter構造方法的logger實例
fmt = logging.Formatter("%(asctime)s - %(name)s - %(ip)s - %(username)s - %(message)s")
h_console = logging.StreamHandler(sys.stdout)
h_console.setFormatter(fmt)
init_logger = logging.getLogger("myPro")
init_logger.setLevel(logging.DEBUG)
init_logger.addHandler(h_console)# 初始化一個要傳遞給LoggerAdapter構造方法的上下文字典對象
extra_dict = {"ip": "IP", "username": "USERNAME"}# 獲取一個LoggerAdapter類的實例
logger = logging.LoggerAdapter(init_logger, extra_dict)# 應用中的日志記錄方法調用
logger.info("User Login!")
logger.info("User Login!", extra={"ip": "113.208.78.29", "username": "Petter"})
logger.extra = {"ip": "113.208.78.29", "username": "Petter"}
logger.info("User Login!")
logger.info("User Login!")

輸出結果：

# 使用extra默認值：{"ip": "IP", "username": "USERNAME"}
2017-05-14 17:23:15,148 - myPro - IP - USERNAME - User Login!# info(msg, extra)方法中傳遞的extra方法沒有覆蓋默認值
2017-05-14 17:23:15,148 - myPro - IP - USERNAME - User Login!# extra默認值被修改了
2017-05-14 17:23:15,148 - myPro - 113.208.78.29 - Petter - User Login!
2017-05-14 17:23:15,148 - myPro - 113.208.78.29 - Petter - User Login!

根據上面的程序輸出結果，我們會發現一個問題：傳遞給LoggerAdapter類構造方法的extra參數值不能被LoggerAdapter實例的日志記錄函數（如上面調用的info()方法）中的extra參數覆蓋，只能通過修改LoggerAdapter實例的extra屬性來修改默認值（如上面使用的logger.extra=xxx），但是這也就意味著默認值被修改了。

解決這個問題的思路應該是：實現一個LoggerAdapter的子類，重寫process()方法。其中對于kwargs參數的操作應該是先判斷其本身是否包含extra關鍵字，如果包含則不使用默認值進行替換；如果kwargs參數中不包含extra關鍵字則取默認值。來看具體實現：

import logging
import sysclass MyLoggerAdapter(logging.LoggerAdapter):def process(self, msg, kwargs):if 'extra' not in kwargs:kwargs["extra"] = self.extrareturn msg, kwargsif __name__ == '__main__':# 初始化一個要傳遞給LoggerAdapter構造方法的logger實例fmt = logging.Formatter("%(asctime)s - %(name)s - %(ip)s - %(username)s - %(message)s")h_console = logging.StreamHandler(sys.stdout)h_console.setFormatter(fmt)init_logger = logging.getLogger("myPro")init_logger.setLevel(logging.DEBUG)init_logger.addHandler(h_console)# 初始化一個要傳遞給LoggerAdapter構造方法的上下文字典對象extra_dict = {"ip": "IP", "username": "USERNAME"}# 獲取一個自定義LoggerAdapter類的實例logger = MyLoggerAdapter(init_logger, extra_dict)# 應用中的日志記錄方法調用logger.info("User Login!")logger.info("User Login!", extra={"ip": "113.208.78.29", "username": "Petter"})logger.info("User Login!")logger.info("User Login!")

輸出結果：

# 使用extra默認值：{"ip": "IP", "username": "USERNAME"}
2017-05-22 17:35:38,499 - myPro - IP - USERNAME - User Login!# info(msg, extra)方法中傳遞的extra方法已覆蓋默認值
2017-05-22 17:35:38,499 - myPro - 113.208.78.29 - Petter - User Login!# extra默認值保持不變
2017-05-22 17:35:38,499 - myPro - IP - USERNAME - User Login!
2017-05-22 17:35:38,499 - myPro - IP - USERNAME - User Login!

OK！ 問題解決了。

其實，如果我們想不受formatter的限制，在日志輸出中實現自由的字段插入，可以通過在自定義LoggerAdapter的子類的process()方法中將字典參數中的關鍵字信息拼接到日志事件的消息中。很明顯，這些上下文中的字段信息在日志輸出中的位置是有限制的。而使用'extra'的優勢在于，這個類字典對象的值將被合并到這個LogRecord實例的__dict__中，這樣就允許我們通過Formatter實例自定義日志輸出的格式字符串。這雖然使得上下文信息中的字段信息在日志輸出中的位置變得與內置字段一樣靈活，但是前提是傳遞給構造器方法的這個類字典對象中的key必須是確定且明了的。

三、使用Filters引入上下文信息

---

另外，我們還可以使用自定義的Filter.Filter實例的方式，在filter(record)方法中修改傳遞過來的LogRecord實例，把要加入的上下文信息作為新的屬性賦值給該實例，這樣就可以通過指定formatter的字符串格式來輸出這些上下文信息了。

我們模仿上面的實現，在傳遞個filter(record)方法的LogRecord實例中添加兩個與當前網絡請求相關的信息：ip和username。

import logging
from random import choiceclass ContextFilter(logging.Filter):ip = 'IP'username = 'USER'def filter(self, record):record.ip = self.iprecord.username = self.usernamereturn Trueif __name__ == '__main__':levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)users = ['Tom', 'Jerry', 'Peter']ips = ['113.108.98.34', '219.238.78.91', '43.123.99.68']logging.basicConfig(level=logging.DEBUG,format='%(asctime)-15s %(name)-5s %(levelname)-8s %(ip)-15s %(username)-8s %(message)s')logger = logging.getLogger('myLogger')filter = ContextFilter()logger.addFilter(filter)logger.debug('A debug message')logger.info('An info message with %s', 'some parameters')for x in range(5):lvl = choice(levels)lvlname = logging.getLevelName(lvl)filter.ip = choice(ips)filter.username = choice(users)logger.log(lvl, 'A message at %s level with %d %s' , lvlname, 2, 'parameters')

輸出結果：

2017-05-15 10:21:49,401 myLogger DEBUG    IP              USER     A debug message
2017-05-15 10:21:49,401 myLogger INFO     IP              USER     An info message with some parameters
2017-05-15 10:21:49,401 myLogger INFO     219.238.78.91   Tom      A message at INFO level with 2 parameters
2017-05-15 10:21:49,401 myLogger INFO     219.238.78.91   Peter    A message at INFO level with 2 parameters
2017-05-15 10:21:49,401 myLogger DEBUG    113.108.98.34   Jerry    A message at DEBUG level with 2 parameters
2017-05-15 10:21:49,401 myLogger CRITICAL 43.123.99.68    Tom      A message at CRITICAL level with 2 parameters
2017-05-15 10:21:49,401 myLogger INFO     43.123.99.68    Jerry    A message at INFO level with 2 parameters

需要說明的是： 實際的網絡應用程序中，可能還要考慮多線程并發時的線程安全問題，此時可以把連接信息或者自定義過濾器的實例通過threading.local保存到到一個threadlocal中。

• 參考文檔：https://docs.python.org/3.5/howto/logging-cookbook.html#adding-contextual-information-to-your-logging-output

  問題交流群：666948590

轉載于:https://www.cnblogs.com/yyds/p/6897964.html

總結

以上是生活随笔為你收集整理的Python之向日志输出中添加上下文信息的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。