Wie füge ich dem Python-Protokollformat-String ein benutzerdefiniertes Feld hinzu?

Question

Meine aktuelle Format-String ist:

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

und ich möchte ein neues Feld app_name und die haben einen anderen Wert in jedem Skript, das diesen Formatierer enthält genannt hinzuzufügen.

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

Aber ich bin nicht sicher, wie man den Logger, dass app_name Wert zu übergeben in das Format-String zu interpolieren. Ich kann es offensichtlich in der Protokollnachricht erscheinen lassen, aber es jedes Mal passieren, aber das ist chaotisch.

Ich habe versucht:

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

aber keine Arbeit.

Answer 1

Sie könnten ein verwenden LoggingAdapter so haben Sie nicht die zusätzlichen Informationen mit jeder Protokollierung Anruf weitergeben müssen:

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') 

Protokolle (so etwas wie)

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

---

Filters kann auch verwendet werden, um kontextbezogene Informationen hinzuzufügen.

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') 

erzeugt einen ähnlichen Protokolleintrag.

Answer 2

Sie müssen das Diktat als Parameter zu Extra übergeben, um es so zu machen.

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

Beweis:

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

Auch als Notiz, wenn Sie versuchen, eine Nachricht zu protokollieren, ohne die dict vorbei, dann wird es scheitern.

>>> 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