Configuration
-------------

Add the middleware to your Django settings:

.. code-block:: python

    # settings.py
    INSTALLED_APPS = [
        ...
        'dj_access_logger'
        ...
    ]

    MIDDLEWARE = [
        ...
        'dj_access_logger.middleware.AccessLoggerMiddleware',
        ...
    ]

    # Logging configuration
    DJ_ACCESS_LOGGER = {
        'method': 'file',  # 'file' or 'sql' or 'nosql'
        'separated_logging_db': True,
        'obfuscate_secrets': True,
        'logging_db_parameters': {
            'ENGINE': 'django.db.backends.mysql',  # Use 'djongo' for MongoDB
            'NAME': 'logging_db',
            'USER': 'logging_user',
            'PASSWORD': 'logging_password',
            'HOST': 'localhost',
            'PORT': '3306',
            'NOSQL_HOST': 'mongodb://localhost:27017',  # NoSQL specific parameter
        }
    }


    # If using a separate logging database, add this to your DATABASE_ROUTERS
    DATABASE_ROUTERS = [
        ...,
        'dj_access_logger.db_router.LoggingDBRouter',
        ...
    ]

Setup
--------
After changing your settings.py you need to run the following commands to create the necessary tables in the logging database:

.. code-block:: bash
    python manage.py setup_dj_access_logger