Releasing wsgi-request-logger v0.4

Author: pklaus

.gitignore

@@ -0,0 +1,15 @@
+dist/
+MANIFEST
+__pycache__
+*.pyc
+*.pyo
+*~
+.DS_Store
+build/
+dist/
+.project
+.pydevproject
+.settings/
+*.DS_Store
+*.swp
+

.hgignore

@@ -0,0 +1,27 @@
+Copyright (c) 2013, Philipp Klaus. All rights reserved.
+Copyright (c) 2007-2011 L. C. Rees. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+2.  Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+3.  Neither the name of the Portable Site Information Project nor the names
+of its contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

LICENSE

@@ -0,0 +1,61 @@
+## Request Logging for WSGI Web Applications
+
+This is a middleware which you can use to log requests to your WSGI based site.
+It's even imitating Apache's combined log format to allow you to use any of the
+many tools for Apache log file analysis.
+
+By making use of Python's Logger Facilities, you can easily log to STDOUT, time rotated log files, email, syslog, etc.
+
+#### Installation
+
+Simply install this Python module via
+
+    pip install wsgi-request-logger
+
+#### Usage
+
+To add this plugin to your WSGI `application` and log to the file *access.log*, do:
+
+    from requestlogger import ApacheLogger
+    from logging.handlers import TimedRotatingFileHandler
+    
+    def application(environ, start_response):
+        response_body = 'The request method was %s' % environ['REQUEST_METHOD']
+        response_body = response_body.encode('utf-8')
+        response_headers = [('Content-Type', 'text/plain'),
+                            ('Content-Length', str(len(response_body)))]
+        start_response('200 OK', response_headers)
+        return [response_body]
+    
+    handlers = [ TimedRotatingFileHandler('access.log', 'd', 7) , ]
+    loggingapp = ApacheLogger(application, handlers)
+    
+    if __name__ == '__main__':
+        from wsgiref.simple_server import make_server
+        http = make_server('', 8080, loggingapp)
+        http.serve_forever()
+
+
+#### The Authors
+
+This WSGI middlewre was originally developed under the name [wsgilog](https://pypi.python.org/pypi/wsgilog/) by  **L. C. Rees**.
+It was forked by **Philipp Klaus** in 2013 to build a WSGI middleware for request logging rather than exception handling and logging.  
+
+
+#### License
+
+This software, *wsgi-request-logger*, is published under a *3-clause BSD license*.
+
+#### Developers' Resources
+
+* To read about your options for the logging handler, you may want to read [Python's Logging Cookbook](http://docs.python.org/3/howto/logging-cookbook.html).
+* Documentation on Apache's log format can be found [here](http://httpd.apache.org/docs/current/mod/mod_log_config.html#logformat).
+* The [WSGI](http://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) - Web Server Gateway Interface - is defined in [PEP 333](http://www.python.org/dev/peps/pep-0333/) with an update for Python 3 in [PEP 3333](http://www.python.org/dev/peps/pep-3333/).
+
+#### General References
+
+* PyPI's [listing of wsgi-request-logger](https://pypi.python.org/pypi/wsgi-request-logger)
+* The source code for this Python module is [hosted on Github](https://github.com/pklaus/wsgi-request-logger).
+
+
+

README.md

@@ -0,0 +1,4 @@
+### ToDo
+
+* The [extraction of the request and response meta data (done manually using the environ variable right now) could also be done](http://docs.webob.org/en/latest/comment-example.html#the-middleware) using webob's [Request](http://docs.webob.org/en/latest/modules/webob.html#request) and [Response](http://docs.webob.org/en/latest/modules/webob.html#response) classes.  
+  Or using [pylons.util](http://stackoverflow.com/a/2655396/183995).

README.rst

@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*-
+
+"""
+Apache-like combined logging for WSGI Web Applications.
+
+Homepage: https://github.com/pklaus/wsgi-request-logger
+
+Copyright (c) 2013, Philipp Klaus. All rights reserved.
+Copyright (c) 2007-2011 L. C. Rees. All rights reserved.
+
+License: BSD (see LICENSE for details)
+"""
+
+import time
+from datetime import datetime as dt
+import logging
+
+from .timehacks import Local
+
+__all__ = ['WSGILogger', 'ApacheFormatter', 'log']
+
+class WSGILogger(object):
+    ''' This is the generalized WSGI middleware for any style request logging. '''
+
+    def __init__(self, application, handlers, formatter=None, **kw):
+        self.formatter = formatter or WSGILogger.standard_formatter
+        self.logger = logging.getLogger('requestlogger')
+        self.logger.setLevel(logging.DEBUG)
+        for handler in handlers:
+            self.logger.addHandler(handler)
+        self.application = application
+
+    def __call__(self, environ, start_response):
+        start = time.clock()
+        status_codes = []
+        content_lengths = []
+        def custom_start_response(status, response_headers, exc_info=None):
+            status_codes.append(int(status.partition(' ')[0]))
+            for name, value in response_headers:
+                if name.lower() == 'content-length':
+                    content_lengths.append(int(value))
+                    break
+            return start_response(status, response_headers, exc_info)
+        retval = self.application(environ, custom_start_response)
+        runtime = int((time.clock() - start) * 10**6)
+        content_length = content_lengths[0] if content_lengths else len(b''.join(retval))
+        msg = self.formatter(status_codes[0], environ, content_length, rt_ms=runtime)
+        self.logger.info(msg)
+        return retval
+
+    @staticmethod
+    def standard_formater(status_code, environ, content_length):
+        return "{} {}".format(dt.now().isoformat(), status_code)
+
+def ApacheFormatter(with_response_time=True):
+    ''' A factory that returns the wanted formatter '''
+    if with_response_time:
+        return ApacheFormatters.format_with_response_time
+    else:
+        return ApacheFormatters.format_NCSA_log
+
+class ApacheFormatters(object):
+
+    @staticmethod
+    def format_NCSA_log(status_code, environ, content_length):
+        """
+          Apache log format 'NCSA extended/combined log':
+          "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
+          see http://httpd.apache.org/docs/current/mod/mod_log_config.html#formats
+        """
+        
+        # Let's collect log values
+        val = dict()
+        val['host'] = environ.get('REMOTE_ADDR', '')
+        val['logname'] = '-'
+        val['user'] = '-'
+        val['time'] = dt.now(tz=Local).strftime("%d/%b/%Y:%H:%M:%S %z")
+        val['request'] = "{} {} {}".format(
+              environ.get('REQUEST_METHOD', ''),
+              environ.get('PATH_INFO', ''),
+              environ.get('SERVER_PROTOCOL', '')
+            )
+        val['status'] = status_code
+        val['size'] = content_length
+        val['referer'] = environ.get('HTTP_REFERER', '')
+        val['agent'] = environ.get('HTTP_USER_AGENT', '')
+        
+        # see http://docs.python.org/3/library/string.html#format-string-syntax
+        FORMAT = '{host} {logname} {user} [{time}] "{request}" '
+        FORMAT += '{status} {size} "{referer}" "{agent}"'
+        return FORMAT.format(**val)
+
+    @staticmethod
+    def format_with_response_time(*args, **kw):
+        """
+          The dict kw should contain 'rt_ms', the response time in milliseconds.
+          This is the format for TinyLogAnalyzer:
+          https://pypi.python.org/pypi/TinyLogAnalyzer
+        """
+        rt_ms = kw.get('rt_ms')
+        return ApacheFormatters.format_NCSA_log(*args) + " {}/{}".format(int(rt_ms/1000000), rt_ms)
+
+def log(handlers, formatter=ApacheFormatter(), **kw):
+    '''Decorator for logging middleware.'''
+    def decorator(application):
+        return WSGILogger(application, handlers, **kw)
+    return decorator
+

TODO.md

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+"""
+    Source: http://docs.python.org/3/library/datetime.html → "Example tzinfo classes"
+    Idea:   http://stackoverflow.com/a/2071364/183995
+"""
+
+from datetime import datetime as dt, tzinfo, timedelta
+import time as _time
+
+STDOFFSET = timedelta(seconds = -_time.timezone)
+if _time.daylight:
+    DSTOFFSET = timedelta(seconds = -_time.altzone)
+else:
+    DSTOFFSET = STDOFFSET
+
+DSTDIFF = DSTOFFSET - STDOFFSET
+
+class LocalTimezone(tzinfo):
+
+    def utcoffset(self, dt):
+        if self._isdst(dt):
+            return DSTOFFSET
+        else:
+            return STDOFFSET
+
+    def dst(self, dt):
+        if self._isdst(dt):
+            return DSTDIFF
+        else:
+            return ZERO
+
+    def tzname(self, dt):
+        return _time.tzname[self._isdst(dt)]
+
+    def _isdst(self, dt):
+        tt = (dt.year, dt.month, dt.day,
+              dt.hour, dt.minute, dt.second,
+              dt.weekday(), 0, 0)
+        stamp = _time.mktime(tt)
+        tt = _time.localtime(stamp)
+        return tt.tm_isdst > 0
+
+Local = LocalTimezone()
+