Skip to main content

log4django is full features logging platform for django applications.

Project description

log4django is full features logging platform for django applications. The project is in very early stage, so excuse the brief documentation.


  • python 2.7
  • packages listed in


Install via pipy or copy this module into your project or into your PYTHON_PATH.

In your file:

Add log4django into INSTALLED_APPS.




Add log_request_id to MIDDLEWARE_CLASSES

    # ... other middleware goes here

Configure your logging with log4django appender.

    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
       'request_id': {
           '()': 'log_request_id.filters.RequestIDFilter'
    'handlers': {
        'log4django': {
            'level': 'DEBUG',
            'class': 'log4django.handlers.ModelHandler', # Synchronous log creations.
            'filters': ['request_id']
        'log4django_async': {
            'level': 'DEBUG',
            'class': 'log4django.handlers.GearmanHandler', # Asynchronous log creations, doesn't block.
            'filters': ['request_id']
    'loggers': {
        '': {
            'handlers': ['log4django_async'],
            'level': 'DEBUG'

        # South logger needs to be disabled, in order to be able to migrate log4django
        'south': {
           'handlers': ['null'],
           'level': 'INFO',
           'propagate': False

Add log4django urls into ROOT_URLCONF.

urlpatterns = patterns('',
    ....your other patterns
    url(r'^', include('log4django.urls', namespace='log4django', app_name='log4django')),

Defining namespace and app_name is important. Log4Django uses namespacing internally to avoid url name collisions.


django constants with default values.

LOG4DJANGO_PAGE_TITLE = 'log4django'
LOG4DJANGO_DEFAULT_APP_ID = None  # If you have only one app, put here
LOG4DJANGO_GEARMAN_TASK_NAME = 'log4django_event'
LOG4DJANGO_PAGE_SIZE = 100  # How many records to display on one page.
LOG4DJANGO_PAGINATOR_RANGE = 15  # How many pages to show in pagination.
LOG4DJANGO_EXTRA_DATA_INDENT = 4  # Extra data json indentation.
))  # Basic authentication
))  # Controlls how records are persisted.
LOG4DJANGO_CSV_EXPORT_EXTRA_JSON_PATHS = tuple()  #  List of json paths to include in csv export.

Running asynchronously

Asynchronous queue is managed by gearman job server ( In your logging config use log4django.handlers.GearmanHandler as handler class. This way web request threads are not blocked by overhead of saving a lots of log records to your database backend, but are sent to asynchronous queue insted. You will also have to run management command that acts as gearman worker, pops log records from queue and saves log records to database asynchronously.

$ python log4django

Development setup

$ make bootstrap
$ python test log4django
$ python runserver


Tested on evnironment

  • Linux Mint 15 Olivia 64-bit
  • python 2.7.4
  • python unitest

Running tests

To run the tests, execute one of the following command::

$ python test log4django


$ make test


char0n (Vladimir Gorej, CodeScale)

Project details

Download files

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

Source Distribution

log4django-0.9.1.tar.gz (445.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page