django-log-lens 0.1.9

A lightweight Django app for viewing and managing log data conveniently

Django Log Lens is a Django app that provides a simple, lightweight and easy-to-use logging system for your Django project.

Getting Started

1. Install django-log-lens from PyPI

pip install django-log-lens

2. Add django_log_lens to your INSTALLED_APPS

# file: settings.py

INSTALLED_APPS = [
    'django_log_lens',
    ...
]

3. Add URL patterns to your urls.py

# file: urls.py
from django.urls import include

urlpatterns = [
    path('logs/', include('django_log_lens.urls')),
    ...
]

4. Add a LOGGING configuration in your settings.py

Follow the instructions from the official Django documentation to configure the logging system or use the example below.

# file: settings.py
from django_log_lens import LOG_FORMAT

LOG_FOLDER = BASE_DIR / "logs"

if not os.path.exists(LOG_FOLDER):
    os.makedirs(LOG_FOLDER)

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {"default": {"format": LOG_FORMAT}},
    "handlers": {
        "log_collector": {
            "level": "WARNING",
            "class": "logging.FileHandler",
            "filename": str(LOG_FOLDER / "collector.log"),
            "formatter": "default",
        },
        "client_logger": {
            "level": "DEBUG",
            "class": "logging.FileHandler",
            "filename": str(LOG_FOLDER / "client.log"),
            "formatter": "default",
        },
    },
    "loggers": {
        "django_log_lens.client": {"handlers": ["client_logger"], "level": "DEBUG", "propagate": True},
        "django" : {"handlers": ["log_collector"], "level": "DEBUG", "propagate": True},
    }
}

ALLOW_JS_LOGGING = True  # django_log_lens setting: allows clients to send console logs to the server

5. Visit Log Lens

You can now visit Django Log Lens by navigating to {% url 'django_log_lens:view' %} (code for your template) - if you configured the URL pattern as shown above, this would be logs/view

Third Party Licenses

This project uses the Dracula theme by Zeno Rocha which is licensed under the MIT License