This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Augments each request with unique request_id attribute and provides request id logging helpers.

Developed and used at en.ig.ma software shop.

Quickstart

  1. Include django-request-id in your requirements.txt file.

  2. Add request_id to INSTALLED_APPS (necessary only if you are going to use the {% request_id %} template tag).

  3. Add request_id.middleware.RequestIdMiddleware at the top of the MIDDLEWARE Django setting.

  4. The app integrates with the standard Python/Django logging by defining a filter that puts a request_id variable in scope of every log message.

    First add a filter definition to the Django LOGGING settings:

    "filters": {
        "request_id": {
            "()": "request_id.logging.RequestIdFilter"
        }
    }
    

    Then enable the filter for related handlers:

    "handlers": {
        "console": {
            ...
            "filters": ["request_id"],
        }
     }
    

    And finally modify formatter output format to include the %(request_id) placeholder:

    "formatters": {
        "console": {
            "format": "%(asctime)s - %(levelname)-5s [%(name)s] request_id=%(request_id)s %(message)s"
        }
    }
    

    A full Django logging config example may look like this:

    LOGGING= {
        "version": 1,
        "disable_existing_loggers": False,
        "filters": {
            "request_id": {
                "()": "request_id.logging.RequestIdFilter"
            }
        },
        "formatters": {
            "console": {
                "format": "%(asctime)s - %(levelname)-5s [%(name)s] request_id=%(request_id)s %(message)s",
                "datefmt": "%H:%M:%S"
            }
        },
        "handlers": {
            "console": {
                "level": "DEBUG",
                "filters": ["request_id"],
                "class": "logging.StreamHandler",
                "formatter": "console"
            }
        },
        "loggers": {
            "": {
                "level": "DEBUG",
                "handlers": ["console"]
            }
        }
    }
    
  5. Make sure that your web server adds a X-Request-ID header to each request (and logs it in the server log for further matching of the server and app log entries).

    If you can’t generate the X-Request-Id header at the web server level then simply set REQUEST_ID_HEADER = None in your project settings and the app will generate a unique id value automatically instead of retrieving it from the wsgi environment.

    For more info on server configs see server-config.

Dependencies

None.

Documentation and demo

The full documentation is at http://django-request-id.rtfd.org.

There’s also an instant demo example that can be run from the cloned repository:

python demo.py

See the integration in action on Heroku:

License

django-request-id is released under the MIT license.

Other Resources

Commercial Support

This app and many other help us build better software and focus on delivering quality projects faster. We would love to help you with your next project so get in touch by dropping an email at en@ig.ma.

History

1.0.0 (2016-10-23)

  • Django 1.10 compatibility

0.1.0 (2014-01-30)

  • First release
Release History

Release History

1.0.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_request_id-1.0.0-py2.py3-none-any.whl (11.8 kB) Copy SHA256 Checksum SHA256 3.5 Wheel Oct 23, 2016
django-request-id-1.0.0.tar.gz (6.6 kB) Copy SHA256 Checksum SHA256 Source Oct 23, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting