selectively log requests using logging module

Question

All the requests and responses are logged in a web framework, but it is logging(using the logging module) in passwords also (because passwords are in login requests).

Can i selectively print 'XXXXXXX' for password or any other fields i dont wish to print?

in authentication.py

import logging
from logging import config
logging.config.dictConfig({'version': 1, 'delete_existing_loggers': False, 'handlers': '.....'})

LOGGER = logging.getLogger(__name__)

##code to get variables from http request packet (like method, parameters)(for example, methods, params can be: [authentication.login, username, password], [authentication.change_password, username, old_password, new_password], [authentication.generate_validation_code, username]),
LOGGER.info('method %s with %s parameters called', method, params)

so here i want, for specific methods, some variables should be 'xxxxx' instead of original value, specifically if the method is 'authentication.login' I want to print 'xxxx' for second parameter in the params.

Thanks.

It's best to sanitize data at the application level, before you pass it down to the logging module. Of course, you could write some custom formatter that removes sensitive information, but that would be hard to maintain and it might not be 100% effective. — Unknown
– Unknown, Commented Apr 16, 2014 at 6:02
@SpoonMeiser this at the middleware where the requests are processed after variables are stripped out of http request. So will not work. — Neil
– Neil, Commented Apr 16, 2014 at 7:35
I don't understand. Please can you elaborate in the question; show us the code that does the logging, some example output or something? — SpoonMeiser
– SpoonMeiser, Commented Apr 16, 2014 at 23:36

Christian Aichinger · Accepted Answer · 2014-04-16 06:02:33Z

2

Yes, that's possible. Take a look at the logging.Filter class. You need to subclass it and then register it with your logger.

Example:

class PasswordLoggingFilter(logging.Filter):
    def filter(self, record):
        # Modify record, especially record.msg and/or record.args.
        if want_to_keep_record:
            return True
        else:
            return False

logger.addFilter(PasswordLoggingFilter())

For the details of the record object, it's documented here.

answered Apr 16, 2014 at 6:02

Christian Aichinger

7,2674 gold badges46 silver badges63 bronze badges

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

3 Comments

Neil Over a year ago

Can you please tell if the parameters that we give in logger.info(msg, a, b) will a, b be available in record in filter function? I have tried it and by the time control reaches filter function, there seems to be no other arguments (a, b)

Christian Aichinger Over a year ago

The record argument for the filter() function is an object of class LogRecord (see here. record.msg contains the original message string, record.args contains the arguments.

Neil Over a year ago

Thanks its working. Initially it did not work because in the dictConfi i passed handlers.

Neil · Accepted Answer · 2014-04-23 09:11:10Z

0

In addition to solution provided by Christian, if handlers are passed in dictConfig or fileConfig, handler classes should be subclassed and filters need to be added.

Code is taken from following web page: http://streamhacker.com/2010/04/08/python-logging-filters/

class InfoFilter(logging.Filter):
def filter(self, rec):
    return rec.levelno == logging.INFO

class InfoHandler(logging.StreamHandler):
def __init__(self, *args, **kwargs):
    StreamHandler.__init__(self, *args, **kwargs)
    self.addFilter(InfoFilter())

In addition if one wants to change record's arg field, one has to take it into a list and then change it and reassign it back.

answered Apr 23, 2014 at 9:11

Neil

4992 gold badges6 silver badges16 bronze badges

Collectives™ on Stack Overflow

selectively log requests using logging module

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related