How to Implement Comprehensive SQL Query Logging in Django?

Comprehensive SQL Query Logging in Django

Capturing all SQL queries executed by your Django application is crucial for debugging, performance analysis, and security audits. Here's a comprehensive guide to achieve this:

Modify your settings.py file and merge the following snippet into the LOGGING field:

<code class="python">LOGGING = {
    'version': 1,
    'filters': {
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        }
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
        }
    },
    'loggers': {
        'django.db.backends': {
            'level': 'DEBUG',
            'handlers': ['console'],
        }
    }
}</code>

This configuration routes all Django database backend messages (SQL queries) to the console handler. By default, this will only be visible when DEBUG mode is enabled.

To capture all SQL statements in a file named all-sql.log, you can add the following configuration:

<code class="python">HANDLERS = {
    ...  # existing handlers

    'file': {
        'level': 'DEBUG',
        'class': 'logging.FileHandler',
        'filename': '/path/to/all-sql.log',  # adjust file path as needed
    }
}</code>

Finally, add the new file handler to the loggers configuration:

<code class="python">LOGGERS = {
    ...  # existing loggers

    'django.db.backends': {
        'level': 'DEBUG',
        'handlers': ['console', 'file'],  # add 'file' handler
    }
}</code>

With these changes, all SQL queries will be logged to both the console (when DEBUG is enabled) and the specified file. Adjust the file path in the filename parameter to suit your needs. Restart your Django application to enable the logging functionality.

The above is the detailed content of How to Implement Comprehensive SQL Query Logging in Django?. For more information, please follow other related articles on the PHP Chinese website!