Skip to main content

A simple Django app to log requests/responses in various formats, such as JSON.

Project description

Django Logging
==============

A Django library that logs request, response and exception details in a JSON document.
It uses the python rotation mechanism to rotate the file logs, but the rotation files will be gziped.



Installation
============

.. code-block:: python

pip install git+https://github.com/cipriantarta/django-logging

or

.. code-block:: python

pip install django-logging-json

Quick start
===========
1. Add "django_logging" to your INSTALLED_APPS settings like this:

.. code-block:: python

INSTALLED_APPS = (
...
'django_logging',
)


2. Include the DjangoLoggingMiddleware middleware in your MIDDLEWARE_CLASSES like this:

.. code-block:: python

MIDDLEWARE_CLASSES = (
'django_logging.middleware.DjangoLoggingMiddleware',
...
)

Handlers
========

AppFileHandler
--------------

This handle will log request/response info to ``LOG_PATH/app.log``. It will also log request/exception, for unhandled exceptions, in the same file.
Log format:

Request and Response

.. code-block:: javascript

{
"INFO":
{
"timestamp":
{
"request": {
... request info ...
},
"response": {
... response info ...
}
}
}
}

Request and Exception

.. code-block:: javascript

{
"ERROR":
{
"timestamp":
{
"request": {
... request info ...
},
"exception": {
"message": "Exception message",
"traceback": [
...
]
}
}
}
}

SQLFileHandler
--------------

This handler will log all queries to ``LOG_PATH/sql.log``.
In a production environment you should set ``LOG_LEVEL = Error`` or ``SQL_LOG = False`` to avoid performance issues.
The queries will also be logged to the console if ``CONSOLE_LOG`` is set to ``True``

DebugFileHandler
----------------

This handler will log debug messages to ``LOG_PATH/debug.log``. This handler is only used when ``settings.DEBUG`` is set to ``True``.

Log format:

.. code-block:: python

[%(levelname)s - %(created)s], file:%(module)s.py, func:%(funcName)s, ln:%(lineno)s: %(message)s


Custom Use
==========


To log debug messages:

.. code-block:: python

from django_logging import log

log.debug('debug message')

To log handled exceptions:

.. code-block:: python

from django_logging import log, ErrorLogObject

log.error(ErrorLogObject(request, exception))

Settings
========
Inspired by Django Rest Framework, Django Logging settings are grouped in a single dictionary.

To override Django Logging settings, add a dictionary in your project's settings file

.. code-block:: python

DJANGO_LOGGING = {
"CONSOLE_LOG": False
}
Default Settings
----------------

.. code-block:: python

CONSOLE_LOG = True
Log to console.

.. code-block:: python

SQL_LOG = True
Log SQL queries.

.. code-block:: python

LOG_LEVEL = 'debug'
If settings.DEBUG is set to True, otherwise LOG_LEVEL is set to 'info'

.. code-block:: python

DISABLE_EXISTING_LOGGERS = True
Set this to False if you want to combine with multiple loggers.

.. code-block:: python

LOG_PATH = '{}/logs'.format(settings.BASE_DIR)
If the logs folder does not exist, it will be created.

.. code-block:: python

IGNORED_PATHS = ['/admin', '/static', '/favicon.ico']
List of URL endpoints to ignore.

.. code-block:: python

RESPONSE_FIELDS = ('status', 'reason', 'charset', 'headers', 'content')
List of response fields to log.

.. code-block:: python

CONTENT_JSON_ONLY = True
Log response content only if its a JSON document.

.. code-block:: python

ROTATE_MB = 100
Maximum size in MB that the log file can have before it gets rotated.

.. code-block:: python

ROTATE_COUNT = 10
Maximum number of rotated log files.


Change Log
==========

1.2 [2015-11-22]
----------------
- added sql logging support
- log entries are now sorted by keys
- console handler now indents the log entries by 4 spaces
- log response content if it's JSON (bug)

1.1 [2015-11-17]
----------------
- added exception "type" for exception log entries

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

django-logging-json-1.2.tar.gz (7.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page