How to input variables in logger formatter?

Question

I currently have:

FORMAT = '%(asctime)s - %(levelname)s - %(message)s'
logging.basicConfig(format=FORMAT, datefmt='%d/%m/%Y %H:%M:%S', filename=LOGFILE, level=getattr(logging, options.loglevel.upper()))

... which works great, however I'm trying to do:

FORMAT = '%(MYVAR)s %(asctime)s - %(levelname)s - %(message)s'

and that just throws keyerrors, even though MYVAR is defined.

Is there a workaround? MYVAR is a constant, so it would be a shame of having to pass it everytime I invoke the logger.

Thank you!

If MYVAR is going to have always the same value, isn't FORMAT = '{} %(asctime)s - %(levelname)s - %(message)s'.format(MYVAR) a possible alternative? — A. Rodas
– A. Rodas, Commented Apr 24, 2013 at 23:43

unutbu · Accepted Answer · 2013-04-25 00:58:01Z

19

You could use a custom filter:

import logging

MYVAR = 'Jabberwocky'


class ContextFilter(logging.Filter):
    """
    This is a filter which injects contextual information into the log.
    """
    def filter(self, record):
        record.MYVAR = MYVAR
        return True

FORMAT = '%(MYVAR)s %(asctime)s - %(levelname)s - %(message)s'
logging.basicConfig(format=FORMAT, datefmt='%d/%m/%Y %H:%M:%S')

logger = logging.getLogger(__name__)
logger.addFilter(ContextFilter())

logger.warning("'Twas brillig, and the slithy toves")

yields

Jabberwocky 24/04/2013 20:57:31 - WARNING - 'Twas brillig, and the slithy toves

edited Apr 25, 2013 at 0:58

answered Apr 25, 2013 at 0:49

unutbu

886k197 gold badges1.9k silver badges1.7k bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Stephan Tual Over a year ago

Thank you ever so much - that's indeed the correct way to proceed!

mmoya Over a year ago

Doesn't work form me in python 2.7. The solution is adding the ContextFilter() to a handler instead.

Vinay Sajip · Accepted Answer · 2013-04-25 06:42:18Z

12

You could use a custom Filter, as unutbu says, or you could use a LoggerAdapter:

import logging

logger = logging.LoggerAdapter(logging.getLogger(__name__), {'MYVAR': 'Jabberwocky'})

FORMAT = '%(MYVAR)s %(asctime)s - %(levelname)s - %(message)s'
logging.basicConfig(format=FORMAT, datefmt='%d/%m/%Y %H:%M:%S')

logger.warning("'Twas brillig, and the slithy toves")

which gives

Jabberwocky 25/04/2013 07:39:52 - WARNING - 'Twas brillig, and the slithy toves

Alternatively, just pass the information with every call:

import logging

logger = logging.getLogger(__name__)

FORMAT = '%(MYVAR)s %(asctime)s - %(levelname)s - %(message)s'
logging.basicConfig(format=FORMAT, datefmt='%d/%m/%Y %H:%M:%S')

logger.warning("'Twas brillig, and the slithy toves", extra={'MYVAR': 'Jabberwocky'})

which gives the same result.

Since MYVAR is practically constant, the LoggerAdapter approach requires less code than the Filter approach in your case.

answered Apr 25, 2013 at 6:42

Vinay Sajip

100k15 gold badges184 silver badges196 bronze badges

1 Comment

Michael Over a year ago

Does logging.basicConfig(format=FORMAT) change the format for all the loggers? How to change it only for this new logger adapter? Thanks

jpgard · Accepted Answer · 2018-05-30 21:29:25Z

6

Borrowing from a comment above, I found that the simplest way to do this when the variable is static for all log entries is to simply include it in the formatter itself:

FORMAT = '{} %(asctime)s - %(levelname)s - %(message)s'.format(MYVAR)

With this method, no custom class implementation is required, and you don't have to worry about methods which are not defined for the various classes (LoggerAdapter and CustomAdapter), such as addHandler(). Admittedly, this is probably less Pythonic but it worked as a quick solution for me.

answered May 30, 2018 at 21:29

jpgard

7017 silver badges16 bronze badges

Comments

TehTris · Accepted Answer · 2013-04-24 23:42:04Z

-1

locals()
FORMAT = '%(MYVAR)s %(asctime)s - %(levelname)s - %(message)s'

locals() should return a dictionary of all variables locally available, then the error. If you don't see it in there, then its not locally available. This will prove its not defined properly. We would need more code to see if it was defined improperly. Alternatively you can try "globals()" to check the global ones.... but you probably arent putting "global MYVAR " in the definition that outputs FORMAT

answered Apr 24, 2013 at 23:42

TehTris

3,2371 gold badge23 silver badges35 bronze badges

1 Comment

Stephan Tual Over a year ago

I tried printing locals and I can see my var as part of the output: 'MYVAR': 'blahblah'

Collectives™ on Stack Overflow

How to input variables in logger formatter?

4 Answers 4

2 Comments

1 Comment

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related