Jak dodać niestandardowe pole do łańcucha formatu dziennika Python?

Question

Mój obecny format string jest:

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

i chcę dodać nowe pole o nazwie APP_NAME i który będzie miał inną wartość w każdym skrypcie zawierający tę formatowania.

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

Ale nie jestem pewien, w jaki sposób przekazać tę wartość app_name do rejestratora interpolować w ciągu formatu. Mogę oczywiście sprawić, by pojawił się w wiadomości dziennika, ale przekazywał ją za każdym razem, ale jest to niechlujne.

Próbowałem:

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

ale żadna praca.

Answer 1

można użyć LoggingAdapter więc nie trzeba przekazać dodatkowe informacje z każdej rozmowy rejestrowania:

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

cylindryczne (coś)

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

---

Filters może również służyć do dodawania informacji kontekstowych.

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

produkuje podobny rekord dziennika.

Answer 2

Musisz przekazać dyktat jako parametr dodatkowy, aby zrobić to w ten sposób.

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

Dowód:

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

Ponadto, jako notatkę, jeśli starają się zalogować wiadomość bez minięciu dict, to nie zadziała.

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