loki-django-logger 1.0.6

Loki logger for Django applications

Loki Django Logger

This package provides a lightweight logging solution for Django applications that sends logs to Grafana Loki with gzip compression for improved performance.

Installation

pip install loki-django-logger

Configuration

1. Add the logger to your Django settings.

In your settings.py:

from loki_django_logger.logger import configure_logger

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "verbose": {
            "format": "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s",
            "datefmt": "%Y-%m-%d %H:%M:%S"
        },
    },
    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "formatter": "verbose",
        },
        "loki": {
            "class": "loki_django_logger.handler.AsyncGzipLokiHandler",
            "loki_url": "https://loki.test.dev",
            "labels": {"application": "django-app", "environment": "development"},
            "level": "DEBUG",
            "flush_interval": 1,
        },
    },
    "loggers": {
        "django": {
            "handlers": ["console", "loki"],
            "level": "INFO",
            "propagate": False,
            "extra": {}  # Add additional metadata here
        },
    },
}

2. Install Loki if not already available:

docker run -d --name=loki -p 3100:3100 grafana/loki:latest

3. Run your Django application and monitor the logs in Loki.

Example Usage

In your Django views or tasks:

import logging
logger = logging.getLogger("django")

def sample_view(request):
    logger.info("Sample log message sent to Loki", extra={"user_id": 123, "operation": "sample_view"})
    return JsonResponse({"message": "Logged successfully!"})

Adding Extra Data to Logs

You can provide additional metadata to your logs using the extra parameter:

logger.error("Failed to process request", extra={"user_id": 456, "error_code": "E500"})

Testing

To run tests:

pytest tests/

License

This project is licensed under the MIT License. See the LICENSE file for details.