How to add tags to python logging

1

Here’s a snippet of sample code that I’m using to log in a python script.

handler = SentryHandler('https://xxxxxxx@sentry.io/xxx')
setup_logging(handler)
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

logger.debug("This is a debug log message")

I’d like to add tags to this, but I don’t know how.

2

You can pass supported arguments via logging’s ‘extra’ parameter. You can also use the tags_context method on raven.Client.

3

Thank you for the reply, and sorry for my ignorance, but ‘tags’ (or ‘tag’) does not seem to be a supported parameter to extra.

logger.debug("This message should contain some extra info", extra={ tags : 'test' })

gives me:
NameError: name 'tags' is not defined

if I change it to:
logger.debug("This message should contain some extra info", extra={ 'tag' : 'test' })

It goes through, but does not actually show as a ‘tag’ in Sentry, it just adds it to the extra data:
But it is not listed as a ‘tag’ on the right under ‘Tags’

tags.png981×481 44.1 KB

Thoughts?

4

A quick follow up.

According to this pull request:

(prepend with http:// … I’m not allowed to post another link… ugh)

I should be able to send tags with the syntax:
logger.debug('Hello', tags={'user': 'dexter'})

But when I try that I get:

Traceback (most recent call last):
  File "/Users/johnsturgeon/Code/greatfootballpool-v2/bin/test.py", line 20, in <module>
    logger.debug('Hello', tags={'user': 'dexter'})
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 1145, in debug
    Log 'msg % args' with severity 'DEBUG'.
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 1153, in debug
    self._log(DEBUG, msg, args, **kwargs)
TypeError: _log() got an unexpected keyword argument 'tags'
5

Your first attempt was correct, but not valid python, it’s extra={‘tags’: {}}

6

FANTASTIC!

Thank you… that did it :thumbsup: