https://github.com/pklaus/wsgi-request-logger

A WSGI HTTP-Request Logger
https://github.com/pklaus/wsgi-request-logger

bottlepy flask python request-logging wsgi-middleware

Last synced: 5 days ago
JSON representation

A WSGI HTTP-Request Logger

• Host: GitHub
• URL: https://github.com/pklaus/wsgi-request-logger
• Owner: pklaus
• License: bsd-3-clause
• Created: 2013-06-17T20:08:14.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-09-14T09:30:51.000Z (over 2 years ago)
• Last Synced: 2024-12-13T20:55:11.543Z (10 days ago)
• Topics: bottlepy, flask, python, request-logging, wsgi-middleware
• Language: Python
• Homepage: http://go.klaus.pw/wsgi-request-logger
• Size: 43.9 KB
• Stars: 48
• Watchers: 6
• Forks: 19
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 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 standard library logging facilities, you can easily set it up to 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 middleware to your WSGI `application` and log to the file *access.log*, do:

    from requestlogger import WSGILogger, ApacheFormatter

    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 = WSGILogger(application, handlers, ApacheFormatter())

    

    if __name__ == '__main__':

        from wsgiref.simple_server import make_server

        http = make_server('', 8080, loggingapp)

        http.serve_forever()

#### The Authors

This WSGI middleware 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).

* A blog post with more background information and usage examples:

  [wsgi-request-logger – Logging HTTP Requests With Any WSGI Web Application like Flask, Bottle or Django](https://blog.philippklaus.de/2013/06/wsgi-request-logger-logging-http-requests-with-any-wsgi-web-application-like-flask-bottle-or-django/)