This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Logging Client-Side JavaScript errors for Django

Project Description

The Django JS Error Logging is logging for Client-Side JavaScript errors. You can log by the following three ways.

  • Save to Django model
  • Notify by Email
  • Logging by python logger

Installation

  1. Add the jserrorlogging directory to your Python path.

    Can use pip command:

    $ pip install django-js-error-logging
    
  2. Add jserrorlogging to your INSTALLED_APPS.:

    INSTALLED_APPS = (
        # ...
        'jserrorlogging',
        # ...
    )
    
  3. Add the following context processor to your TEMPLATE_CONTEXT_PROCESSORS.:

    TEMPLATE_CONTEXT_PROCESSORS = (
        # ...
        'jserrorlogging.context_processors.static',
        # ...
    )
    
  4. Add the following configuration to your urls.py.:

    urlpatterns = patterns(
        # ...
        url(r'^jserr/$', include('jserrorlogging.urls', namespace='jserrorlogging')),
        # ...
    )
    
  5. Add the following templatetag to head tag in your template.:

    <head>
    # ...
    {% include "jserrorlogging/includes/script.html" %}
    # ...
    </head>
    

    About more information of static files for Django, you can see at https://docs.djangoproject.com/en/dev/howto/static-files/.

  6. Add the following static files.

    Copy static/jserrorlogging directory to STATIC_ROOT or run the following command:

    $ python manage.py collectstatic
    
  7. Run syncdb.:

    $ python manage.py syncdb
    

    Note: When your project use South, run the following command.:

    $ python manage.py migrate jserrorlogging
    

    If you don’t want to save to django model, don’t you run these commands.

Configuration

Django JS Error Logging has the following optional settings.

Save to Django model

You can see results of logging in Admin site.

This option is default enabled. When you don’t need to this option, JSERRORLOGGING_ENABLE_MODEL set to False.

Notify by Email

You can send results of logging to Email.

This option is default enabled. When you don’t need to this option, JSERRORLOGGING_ENABLE_MAIL set to False.

JSERRORLOGGING_MAIL_TO

Default: settings.ADMINS

You can set the custom recipients for notification:

JSERRORLOGGING_MAIL_TO = (
    ('someone', 'someone@example.com'),
)
JSERRORLOGGING_MAIL_NOTIFY_INTERVAL

Default: 3600

When the same errors occurred, you can stop notification for the duration of this setting (seconds).

Logging by python logger

You can use Python’s builtin logger.

This option is default disabled. When you need to this option, JSERRORLOGGING_ENABLE_LOGGER set to True. And JSERRORLOGGING_LOGGER_NAME set to your custom logger name.

Example:

LOGGING = {
    # ...
    'loggers': {
        # ...
        'jserror': {
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        },
        # ...
    }
    # ...
}

# ...

JSERRORLOGGING_ENABLE_MODEL = 'jserror'

# ...

About more information of logging for Django, you can see at https://docs.djangoproject.com/en/dev/topics/logging/.

Logging additional data

You can log your custom data.

For example, Django JS Error Logging has another template for the following additional data.

  • django.contrib.auth.User.id
  • request.session.session_key

When you want to log user_id and session_key, set the following templatetag:

<head>
# ...
{% include "jserrorlogging/includes/script_with_user.html" %}
# ...
</head>

If you want to log another data, Create a template that extends jserrorlogging/includes/script.html and edit meta_data block.

Example (path_to_your_template_dir/script_with_more_data.html):

{% extends "jserrorlogging/includes/script.html" %}
{% block meta_data %}
djjserr.meta = {
    username: '{{ user.username }}',
    always_true: true
};
{% endblock %}

Others

other configuration options.

JSERRORLOGGING_LOG_MODEL

Default: ‘jserrorlogging.Log’

A name of model to save log.

JSERRORLOGGING_STATIC_URL

Default: settings.STATIC_URL + ‘jserrorlogging/’

A URL of script files for Django JS Error Logging.

Release History

Release History

This version
History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-js-error-logging-0.1.1.tar.gz (11.9 kB) Copy SHA256 Checksum SHA256 Source Dec 11, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS 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