Skip to main content

A logger to be used internally

Project description

Django Audit Logger

Install

Pip

pip install auditlogger

Dependencies:

  • Django
  • Boto3
  • Celery
  • Redis

Settings

Add the following settings to your settings.py file.

AUDIT_LOG_REGION = ''
AWS_ACCESS_KEY_ID = ''
AWS_SECRET_ACCESS_KEY = ''
AUDIT_LOG_GROUP_NAME = ''
AUDIT_LOG_STREAM_NAME = ''
AUDIT_LOG_EXCLUDE = ['']
# Interval value represents minutes
LOG_INTERVAL = '' (default = 5)

Add auditlogger to your INSTALLED_APPS.

Log models

The User model is logged by default, you can select additional models by using the @auditlogger_update_delete decorator.

@auditlogger_update_delete
class ModelToLog(models.Model):
    name = models.CharField(max_length=100)
    (...)

Custom log events

You can also link other signals used in your app to the logger like so:

from auditlogger.signals import send_log
from django.dispatch import receiver, Signal
from myapp.models import Organisation

organisation_login_signal = Signal(providing_args=['date', 'instance'])


@receiver(organisation_login_signal, sender=Organisation)
def organisation_login(**kwargs):
    """detect organisation logins"""
    send_log('ORGANISATION_LOGIN', **kwargs)

Exclude models

AUDIT_LOG_EXCLUDE = ['Session']

Test

The app comes with included tests that you can run with the following command.

python manage.py test auditlogger

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-audit-logger-1.0.0.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

django_audit_logger-1.0.0-py3-none-any.whl (9.6 kB view hashes)

Uploaded Python 3

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