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.
Requirements
python 2.7
packages listed in setup.py
Installation
Install via pipy or copy this module into your project or into your PYTHON_PATH.
In your settings.py file:
Add log4django into INSTALLED_APPS.
INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'django.contrib.sitemaps', 'debug_toolbar', 'log4django' )
Add log4django INTO CONTEXT_PROCESSORS.
TEMPLATE_CONTEXT_PROCESSORS = ( 'django.contrib.auth.context_processors.auth', 'django.core.context_processors.debug', 'django.core.context_processors.i18n', 'django.core.context_processors.media', 'django.core.context_processors.static', 'django.core.context_processors.tz', 'django.core.context_processors.request', 'django.contrib.messages.context_processors.messages', 'log4django.context_processors.log4django' )
Add log_request_id to MIDDLEWARE_CLASSES
MIDDLEWARE_CLASSES = ( 'log_request_id.middleware.RequestIDMiddleware', # ... other middleware goes here )
Configure your logging with log4django appender.
LOGGING = { '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.
Configuration
django settings.py constants with default values.
LOG4DJANGO_PAGE_TITLE = 'log4django' LOG4DJANGO_CONNECTION_NAME = 'default' LOG4DJANGO_DEFAULT_APP_ID = None # If you have only one app, put App.pk 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. LOG4DJANGO_AUTHENTICATION_PIPELINE', ( 'log4django.pipeline.authentication.is_logged', )) # Basic authentication 'LOG4DJANGO_PERSISTATION_PIPELINE', ( 'log4django.pipeline.process_bundle_data.persist_record', )) # Controlls how records are persisted. LOG4DJANGO_CSV_EXPORT_EXTRA_JSON_PATHS = tuple() # List of json paths to include in csv export. LOG4DJANGO_CSV_DOWNLOAD_FILE_NAME = 'log4django.csv'
Running asynchronously
Asynchronous queue is managed by gearman job server (http://gearman.org/). 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 manage.py log4django
Development setup
$ make bootstrap $ python manage.py test log4django $ python manage.py runserver
Tests
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 manage.py test log4django
Or::
$ make test
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file log4django-0.7.tar.gz
.
File metadata
- Download URL: log4django-0.7.tar.gz
- Upload date:
- Size: 445.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2810aef551a47bd114ae0b4fe2a8e2eb6a3d722b4c2b5e4b8a8be9938fc8919c |
|
MD5 | a00f89ca4efb67e92b8e3712b02cf7a4 |
|
BLAKE2b-256 | 0dcf0cdb1ed747bd678585de287e679fc908d80c3f10d49c9c0d15881c045875 |