Python package for query analysis and monitoring in Django
Project description
Django Query Analyzer
Django Query Analyzer is a Django app that allows you to monitor and analyze the database queries executed by your Django application.
Installation
-
Add "django_query_analyzer" to your
INSTALLED_APPS
setting in your Django project'ssettings.py
:INSTALLED_APPS = [ ... 'django_query_analyzer', ]
-
Add "django_query_analyzer.middleware.QueryAnalyzerMiddleware" to your project's
MIDDLEWARE
list insettings.py
:MIDDLEWARE = [ ... "django_query_analyzer.middleware.QueryAnalyzerMiddleware", ]
-
Register the query analyzer URL patterns in your project's
urls.py
:from django.urls import path, include urlpatterns = [ ... path("query-analyzer/", include("django_query_analyzer.urls")), ]
-
Run the following command to create the necessary database tables for the "django_query_analyzer" package:
python manage.py migrate
Usage
-
Start your Django development server:
python manage.py runserver
-
Visit the query analyzer dashboard at http://127.0.0.1:8000/query-analyzer/ in your web browser.
Configuration
By default, the query analyzer stores the last 50 executed queries. If you want to control this number, you can add the MAX_QUERY_ANALYZER_RECORDS
setting to your project's settings.py
. For example, to store the last 100 queries, add the following line to your settings.py:
MAX_QUERY_ANALYZER_RECORDS = 100
Logging to Terminal
You can control logging to the terminal by adding the ENABLE_LOGGING_TO_TERMINAL
setting to your project's settings.py
. If set to True
, query analysis details will be printed to the terminal. To disable terminal logging, set it to `False.
Example configuration in settings.py:
ENABLE_LOGGING_TO_TERMINAL = True
Excluded Paths
By default, the query analyzer excludes URLs that start with /admin/
, /swagger/
, and /docs/
from its analysis. More control over excluded paths may be available in future updates.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_query_analyzer-0.0.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1ae5730233a7c612a86759be94065ee2be1cd7e72a11aa2e344d76e3bf56c61 |
|
MD5 | 95d0ab7dd08a0b0669ed7800b9888b31 |
|
BLAKE2b-256 | 9e19d047a8819c9843b0831e93302318b78bf0e53bbaeb688868c8186a0e2519 |
Hashes for django_query_analyzer-0.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0f24733078d06b103ee8d95b783250ba8fdea319dd9ab8434d5accf5d58028e |
|
MD5 | 1154d3e5b3c7e6f22e20d060e0d1d20c |
|
BLAKE2b-256 | 3bf82cf149d1c0fa46a29dcf8128ced3aff12ca4523729717e75e871e5d751c3 |