Logmancer

User Guide

  • Getting Started
    • Installation
    • Basic Setup
    • First Steps
      • Manual Logging
      • View Logs in Admin
    • Next Steps
  • Installation
    • Requirements
    • Using pip
    • Using uv
    • Using poetry
    • From Source
    • Development Installation
    • Verifying Installation
    • Next Steps
  • Configuration
    • Basic Configuration
    • Available Settings
      • ENABLE_MIDDLEWARE
      • ENABLE_SIGNALS
      • AUTO_LOG_EXCEPTIONS
      • CLEANUP_AFTER_DAYS
      • LOG_SENSITIVE_KEYS
      • PATH_EXCLUDE_PREFIXES
      • SIGNAL_EXCLUDE_MODELS
      • ENABLE_NOTIFICATIONS
      • NOTIFICATIONS
    • Complete Example

Guides

  • Guides
    • Log Cleanup Strategy
      • Overview
      • Default Behavior
      • Configuration
        • Set Retention Period
        • Manual Cleanup
      • Automated Cleanup
        • Linux/macOS (Cron)
        • Windows Task Scheduler
        • Django Management Command
        • Celery Beat (Recommended for Production)
      • Retention Strategies
        • By Environment
        • By Log Level
        • Selective Retention
      • Database Optimization
        • Add Indexes
        • Vacuum Database (PostgreSQL)
        • Optimize Table (MySQL)
      • Monitoring Cleanup
        • Log Cleanup Activity
        • Database Size Tracking
      • Best Practices
      • Troubleshooting
        • Cleanup Taking Too Long
        • Out of Memory
    • Maintenance Guides
    • Coming Soon

API Reference

  • API Reference
    • Models
      • SafeJSONField
        • SafeJSONField.get_prep_value()
        • SafeJSONField.make_json_safe()
      • LogEntry
        • LogEntry.timestamp
        • LogEntry.level
        • LogEntry.message
        • LogEntry.path
        • LogEntry.method
        • LogEntry.status_code
        • LogEntry.user
        • LogEntry.source
        • LogEntry.actor_type
        • LogEntry.meta
        • LogEntry.get_level_info()
        • LogEntry.get_emoji()
        • LogEntry.get_color()
        • LogEntry.DoesNotExist
        • LogEntry.MultipleObjectsReturned
        • LogEntry.NotUpdated
        • LogEntry.get_actor_type_display()
        • LogEntry.get_level_display()
        • LogEntry.get_next_by_timestamp()
        • LogEntry.get_previous_by_timestamp()
        • LogEntry.id
        • LogEntry.objects
        • LogEntry.user_id
      • LogEntry Model
        • LogEntry
      • SafeJSONField
        • SafeJSONField
    • Middleware
      • DBLoggingMiddleware
        • DBLoggingMiddleware.__init__()
        • DBLoggingMiddleware.mask_sensitive_data()
        • DBLoggingMiddleware.get_user_from_request()
        • DBLoggingMiddleware.log_request()
        • DBLoggingMiddleware.process_exception()
      • get_current_user()
      • DBLoggingMiddleware
        • DBLoggingMiddleware
      • get_current_user
        • get_current_user()
    • Utils
      • LogEvent
        • LogEvent.info()
        • LogEvent.warning()
        • LogEvent.error()
        • LogEvent.debug()
        • LogEvent.critical()
        • LogEvent.fatal()
        • LogEvent.notset()
      • LogEvent Class
        • LogEvent
        • Logging Methods
    • Signals
      • log_model_save()
      • log_model_delete()
      • Signal Handlers
        • log_model_save()
        • log_model_delete()
    • Management Commands
      • logmancer_cleanup
        • Command
        • Command Class
        • Usage
        • Options
        • Examples
        • Configuration
        • Behavior
        • Integration with Django
        • Testing
        • Related Settings
        • See Also
    • Core Modules
      • logmancer.models
        • SafeJSONField
        • LogEntry
      • logmancer.middleware
        • DBLoggingMiddleware
        • get_current_user()
      • logmancer.utils
        • LogEvent
      • logmancer.signals
        • log_model_save()
        • log_model_delete()
      • logmancer.management
        • logmancer.management.commands
  • Models
    • SafeJSONField
      • SafeJSONField.get_prep_value()
      • SafeJSONField.make_json_safe()
    • LogEntry
      • LogEntry.timestamp
      • LogEntry.level
      • LogEntry.message
      • LogEntry.path
      • LogEntry.method
      • LogEntry.status_code
      • LogEntry.user
      • LogEntry.source
      • LogEntry.actor_type
      • LogEntry.meta
      • LogEntry.get_level_info()
      • LogEntry.get_emoji()
      • LogEntry.get_color()
      • LogEntry.DoesNotExist
      • LogEntry.MultipleObjectsReturned
      • LogEntry.NotUpdated
      • LogEntry.get_actor_type_display()
      • LogEntry.get_level_display()
      • LogEntry.get_next_by_timestamp()
      • LogEntry.get_previous_by_timestamp()
      • LogEntry.id
      • LogEntry.objects
      • LogEntry.user_id
    • LogEntry Model
      • LogEntry
        • LogEntry.timestamp
        • LogEntry.level
        • LogEntry.message
        • LogEntry.path
        • LogEntry.method
        • LogEntry.status_code
        • LogEntry.user
        • LogEntry.source
        • LogEntry.actor_type
        • LogEntry.meta
        • LogEntry.get_level_info()
        • LogEntry.get_emoji()
        • LogEntry.get_color()
        • LogEntry.timestamp
        • LogEntry.level
        • LogEntry.message
        • LogEntry.path
        • LogEntry.method
        • LogEntry.status_code
        • LogEntry.user
        • LogEntry.source
        • LogEntry.actor_type
        • LogEntry.meta
        • LogEntry.get_level_info()
        • LogEntry.get_emoji()
        • LogEntry.get_color()
        • LogEntry.__str__()
        • LogEntry.NotUpdated
        • LogEntry.get_actor_type_display()
        • LogEntry.get_level_display()
        • LogEntry.get_next_by_timestamp()
        • LogEntry.get_previous_by_timestamp()
        • LogEntry.id
        • LogEntry.objects
        • LogEntry.user_id
    • SafeJSONField
      • SafeJSONField
        • SafeJSONField.get_prep_value()
        • SafeJSONField.make_json_safe()
  • Middleware
    • DBLoggingMiddleware
      • DBLoggingMiddleware.__init__()
      • DBLoggingMiddleware.mask_sensitive_data()
      • DBLoggingMiddleware.get_user_from_request()
      • DBLoggingMiddleware.log_request()
      • DBLoggingMiddleware.process_exception()
    • get_current_user()
    • DBLoggingMiddleware
      • DBLoggingMiddleware
        • DBLoggingMiddleware.__call__()
        • DBLoggingMiddleware.__acall__()
        • DBLoggingMiddleware.log_request()
        • DBLoggingMiddleware.process_exception()
        • DBLoggingMiddleware.mask_sensitive_data()
        • DBLoggingMiddleware.get_user_from_request()
        • DBLoggingMiddleware.__init__()
        • DBLoggingMiddleware.__call__()
        • DBLoggingMiddleware.__acall__()
        • DBLoggingMiddleware.mask_sensitive_data()
        • DBLoggingMiddleware.get_user_from_request()
        • DBLoggingMiddleware.log_request()
        • DBLoggingMiddleware.process_exception()
    • get_current_user
      • get_current_user()
  • Utils
    • LogEvent
      • LogEvent.info()
      • LogEvent.warning()
      • LogEvent.error()
      • LogEvent.debug()
      • LogEvent.critical()
      • LogEvent.fatal()
      • LogEvent.notset()
    • LogEvent Class
      • LogEvent
        • LogEvent.info()
        • LogEvent.warning()
        • LogEvent.error()
        • LogEvent.debug()
        • LogEvent.critical()
        • LogEvent.fatal()
        • LogEvent.notset()
      • Logging Methods
        • LogEvent.info()
        • LogEvent.warning()
        • LogEvent.error()
        • LogEvent.critical()
        • LogEvent.debug()
        • LogEvent.fatal()
        • LogEvent.notset()
  • Signals
    • log_model_save()
    • log_model_delete()
    • Signal Handlers
      • log_model_save()
      • log_model_delete()
  • Management Commands
    • logmancer_cleanup
      • Command
        • Command.help
        • Command.add_arguments()
        • Command.handle()
      • Command Class
        • Command
      • Usage
      • Options
      • Examples
      • Configuration
      • Behavior
      • Integration with Django
      • Testing
      • Related Settings
      • See Also

Additional

  • Changelog
    • Version 0.1.3 (2025-01-XX)
    • Version 0.1.2 (2024-XX-XX)
    • Version 0.1.1 (2024-XX-XX)
    • Version 0.1.0 (2024-XX-XX)
  • Contributing to Logmancer
    • Getting Started
    • Development Setup
    • Code Style
    • Testing
    • Documentation
    • Pull Request Process
    • Commit Messages
    • Questions?
    • License
Logmancer
  • Overview: module code

All modules for which code is available

  • logmancer.management.commands.logmancer_cleanup
  • logmancer.management.commands.test_notifications
  • logmancer.middleware
  • logmancer.models
  • logmancer.signals
  • logmancer.utils

© Copyright 2025, Abdulsamet TATAR.

Built with Sphinx using a theme provided by Read the Docs.