make this module work nicely with wsgi-request-id

[schlitzered]

add the request uuid to the access log, if wsgi-request-id is used, otherwise ignore it.

some pep8 fixes in setup.py

[schlitzered]

hey, did you had a chance to review this?

[pklaus]

Sorry, it took me so long to respond!

The problem with this pull request is that it changes what users expect from the Apache NCSA log format and it possibly breaks their log file analysis. That's not something that users expect.

Why not create a custom named "formatter" that includes this piece of information by adding it as a @staticmethod just as it's the case with format_with_response_time? In addition it should employ - as a placeholder, in case the REQUEST_ID is not found in the environ dictionary. This could make it a bit more compatible with the Apache conventions and the %L statement of Apache's mod_log_config custom logs format:

class ApacheFormatters(object):

    [...]

    @staticmethod
    def format_with_request_id(status_code, environ, content_length, **kwargs):
        """
        Log the WSGI REQUEST_ID too.
        The request id can be inserted with wsgi-request-id:
        https://pypi.python.org/pypi/wsgi-request-id/
        """
        log_line = ApacheFormatters.format_NCSA_log(status_code, environ, content_length)
        log_line += ' ' + environ.get('REQUEST_ID', '-')
        return  log_line

This formatter could then be used by initializing your logging in the appropriate way:

handlers = [ TimedRotatingFileHandler('access.log', 'd', 7) , ]
loggingapp = WSGILogger(application, handlers, ApacheFormatters.format_with_request_id)

This code is untested yet, but I think this is the way to go without breaking others' setups.

The open question to me is: Do you want the response time to be included in this new output format or not?

What do you think?

[schlitzered]

@pklaus yes, is was not thinking at others logfiles analyzers, you are right, the NSCA format should not be changed.

implementing this as an additional formatter sounds reasonable, so yes, sounds great. It would also be nice to have the response time, at least i am using it.

Thank You.