=============================
Django DB Log
=============================
.. image:: https://badge.fury.io/py/django-db-log-plugin.svg
:target: https://badge.fury.io/py/django-db-log-plugin
.. image:: https://travis-ci.org/eduarde/django-db-log.svg?branch=master
:target: https://travis-ci.org/eduarde/django-db-log
.. image:: https://codecov.io/gh/eduarde/django-db-log/branch/master/graph/badge.svg
:target: https://codecov.io/gh/eduarde/django-db-log
.. image:: https://img.shields.io/pypi/wheel/django-db-log-plugin.svg
:target: https://pypi.org/project/django-db-log-plugin/
Custom DB Log Handler for Django Projects.
Documentation
-------------
The full documentation is at https://django-db-log.readthedocs.io.
Features
-------------
* Capture logs and save them in database.
* Examine logs in the administration page of the website.
* Job scheduler to delete old logs from the database.
Quickstart
----------
Install Django DB Log::
pip install django-db-log-plugin
Add it to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'django_apscheduler',
'django_db_log',
...
)
Add Django DB Log's URL patterns:
.. code-block:: python
from django_db_log import urls as django_db_log_urls
urlpatterns = [
...
url(r'^', include(django_db_log_urls)),
...
]
Add the LOGGING configuration in the settings.py file.
.. code-block:: python
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'verbose': {
'format': '[%(asctime)s] %(levelname)s %(module)s.%(funcName)s %(lineno)d: %(message)s'
},
'simple': {
'format': ' %(levelname)s %(message)s',
},
},
'handlers': {
'log_db': {
'level': 'ERROR',
'class': 'django_db_log.handlers.DBHandler',
'model': 'django_db_log.models.ErrorLog',
'expiry': 86400,
'formatter': 'simple',
},
},
'loggers': {
'django': {
'handlers': ['log_db'],
'level': 'ERROR',
'propagate': False,
},
},
}
Add the following constants in your settings file. These will be used to determine the lookup days to delete old logs from db.
.. code-block:: python
INTERVAL_SCHEDULER_JOB_SECONDS = 43200
GENERAL_LOGS_DELETE_DAYS = 2
INFO_LOGS_DELETE_DAYS = 2
DEBUG_LOGS_DELETE_DAYS = 2
ERROR_LOGS_DELETE_DAYS = 10
Run migrations
.. code-block:: python
python manage.py migrate
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits
-------
* Django_APScheduler_
.. _Django_APScheduler: https://github.com/jarekwg/django-apscheduler
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
-------
0.1.0 (2018-08-29)
++++++++++++++++++
* First release on PyPI.
