Welcome to django_logging Documentation!

django_logging is a powerful yet simple Django package that extends and enhances Python’s built-in logging without relying on any third-party libraries. Our goal is to keep things straightforward while providing flexible and customizable logging solutions that are specifically designed for Django applications.

One of the key advantages of django_logging is its seamless integration. Get started with django_logging in your existing projects without refactoring any code. Even if you’re already using the default logging setup, you can instantly upgrade to advanced features with just a simple installation. No extra changes or complicated setup required!

imagine you have a Django package that was developed a few years ago and already uses Python’s built-in logging. Refactoring the entire codebase to use another logging package would be a daunting task. But with django_logging, you don’t have to worry about that. Simply install django_logging and enjoy all its advanced features with logging each LEVEL in separate files with three extra formats (json, xml, flat) without having to make any changes to your existing code.

Supported Versions

django_logging supports the following combinations of Django and Python versions:

Django	Python
4.2	3.9, 3.10, 3.11, 3.12, 3.13
5.0	3.10, 3.11, 3.12, 3.13
5.1	3.10, 3.11, 3.12, 3.13

Documentation

The documentation is organized into the following sections:

• Quick Start
• Usage
  • Basic Logging Usage
  • Context Manager
  • Log and Notify Utility
  • Execution Tracker
  • Request Logging Middleware
  • MonitorLogSizeMiddleware
  • Context Variable Management
  • send_logs Command
  • generate_pretty_json Command
  • generate_pretty_xml Command
  • logs_size_audit Command
• LogiBoard Integration
  • Setup Instructions
  • Using LogiBoard
• Settings
  • Default configuration
  • Configuration Options
  • AUTO_INITIALIZATION_ENABLE
  • INITIALIZATION_MESSAGE_ENABLE
  • INCLUDE_LOG_iBOARD
  • LOG_SQL_QUERIES_ENABLE
  • LOG_FILE_LEVELS
  • LOG_DIR
  • LOG_DIR_SIZE_LIMIT
  • LOG_FILE_FORMATS
  • LOG_FILE_FORMAT_TYPES
  • EXTRA_LOG_FILES
  • LOG_CONSOLE_LEVEL
  • LOG_CONSOLE_FORMAT
  • LOG_CONSOLE_COLORIZE
  • LOG_DATE_FORMAT
  • LOG_EMAIL_NOTIFIER
  • Available Format Options
  • Required Email Settings
  • Example Email Settings
• Contributing
  • Overview
  • Setting Up Your Environment
  • Testing Your Changes
  • Code Style Guidelines
  • Utilizing Pre-commit Hooks
  • Creating a Pull Request
  • Reporting Issues
  • Resources
• Roles
  • Available Roles

Issues

If you have questions or have trouble using the app please file a bug report at:

https://github.com/lazarus-org/django_logging/issues

Indices and tables

• Search Page

• Index

• Module Index