Skip to main content

Adds information about requests to logging records.

Project description

Latest Version Test/build status Code coverage

This package provides a logging filter and middleware to add information about the current request to the logging record.

Installation and Usage

Install the package, add django_requestlogging to settings.INSTALLED_APPS, add django_requestlogging.middleware.LogSetupMiddleware to settings.MIDDLEWARE_CLASSES, and add django_requestlogging.logging_filters.RequestFilter as a logging filter. See below for an example logging configuration.

The filter adds information about the current request to the logging record. The following keys can be substituted in the logging formatter string:

http_user_agent
The user agent string, provided by the client.
path_info
The requested HTTP path.
remote_addr
The remote IP address.
request_method
The HTTP request method (e.g. GET, POST, PUT, DELETE, etc.)
server_protocol
The server protocol (e.g. HTTP, HTTPS, etc.)
username
The username for the logged-in user.

If any of this information cannot be extracted from the current request (or there is no current request), a hyphen '-' is substituted as a placeholder.

Logging Configuration Example

This logging configuration can be added to your DJANGO_SETTINGS_MODULE. It adds an unbound RequestFilter, which will be bound to the current request by the middleware and then unbound again at response time.

LOGGING = {
    'filters': {
        # Add an unbound RequestFilter.
        'request': {
            '()': 'django_requestlogging.logging_filters.RequestFilter',
        },
    },
    'formatters': {
        'request_format': {
            'format': '%(remote_addr)s %(username)s "%(request_method)s '
            '%(path_info)s %(server_protocol)s" %(http_user_agent)s '
            '%(message)s %(asctime)s',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'filters': ['request'],
            'formatter': 'request_format',
        },
    },
    'loggers': {
        'myapp': {
            # Add your handlers that have the unbound request filter
            'handlers': ['console'],
            # Optionally, add the unbound request filter to your
            # application.
            'filters': ['request'],
        },
    },
}

Project details


Release history Release notifications

This version
History Node

1.2.1

History Node

1.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-requestlogging-redux-1.2.1.tar.gz (8.0 kB) Copy SHA256 hash SHA256 Source None Aug 14, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page