Pythonのログフォーマット文字列にカスタムフィールドを追加するにはどうすればいいですか？

Question

私の現在のフォーマット文字列は次のとおりです。

formatter = logging.Formatter('%(asctime)s : %(message)s') 

と私は、このフォーマッタが含まれている各スクリプトに別の値を持つことになりますAPP_NAMEと呼ばれる新しいフィールドを追加したいとどの。

import logging 
formatter = logging.Formatter('%(asctime)s %(app_name)s : %(message)s') 
syslog.setFormatter(formatter) 
logger.addHandler(syslog) 

しかし、私は、フォーマット文字列に補間するロガーにそのapp_name値を渡しするかどうかはわかりません。私は明らかにそれをログメッセージに表示することができますが、毎回それを渡すが、これは乱雑です。私が試した

：

logging.info('Log message', app_name='myapp') 
logging.info('Log message', {'app_name', 'myapp'}) 
logging.info('Log message', 'myapp') 

が、どれも仕事。

Answer 1

あなたはあなたがすべてのログ呼び出しで、余分な情報を渡す必要はありませんLoggingAdapterを使用することができます。

import logging 
extra = {'app_name':'Super App'} 

logger = logging.getLogger(__name__) 
syslog = logging.StreamHandler() 
formatter = logging.Formatter('%(asctime)s %(app_name)s : %(message)s') 
syslog.setFormatter(formatter) 
logger.setLevel(logging.INFO) 
logger.addHandler(syslog) 

logger = logging.LoggerAdapter(logger, extra) 
logger.info('The sky is so blue') 

ログ（ようなもの）

2013-07-09 17:39:33,596 Super App : The sky is so blue 

---

Filtersを使用してコンテキスト情報を追加することもできます。

import logging 

class AppFilter(logging.Filter): 
    def filter(self, record): 
     record.app_name = 'Super App' 
     return True 

logger = logging.getLogger(__name__) 
logger.addFilter(AppFilter()) 
syslog = logging.StreamHandler() 
formatter = logging.Formatter('%(asctime)s %(app_name)s : %(message)s') 
syslog.setFormatter(formatter) 
logger.setLevel(logging.INFO) 
logger.addHandler(syslog) 

logger.info('The sky is so blue') 

は、同様のログレコードを生成する。

Answer 2

このようにするには、dictをパラメータとして渡す必要があります。

logging.info('Log message', extra={'app_name': 'myapp'}) 

証明：また

>>> import logging 
>>> logging.basicConfig(format="%(foo)s - %(message)s") 
>>> logging.warning('test', extra={'foo': 'bar'}) 
bar - test 

あなたは辞書を通過することなく、メッセージをログに記録しようとすると、ノートのように、それは失敗します。

>>> logging.warning('test') 
Traceback (most recent call last): 
    File "/usr/lib/python2.7/logging/__init__.py", line 846, in emit 
    msg = self.format(record) 
    File "/usr/lib/python2.7/logging/__init__.py", line 723, in format 
    return fmt.format(record) 
    File "/usr/lib/python2.7/logging/__init__.py", line 467, in format 
    s = self._fmt % record.__dict__ 
KeyError: 'foo' 
Logged from file <stdin>, line 1