django-query-analyzer 0.0.16

Python package for query analysis and monitoring in Django

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

1. Install the django-query-analyzer package using pip:

   pip install django-query-analyzer
   

2. Add "django_query_analyzer" to your INSTALLED_APPS setting in your Django project's settings.py:

   INSTALLED_APPS = [
       ...
       'django_query_analyzer',
   ]
   

3. Add "django_query_analyzer.middleware.QueryAnalyzerMiddleware" to your project's MIDDLEWARE list in settings.py:

   MIDDLEWARE = [
       ...
       "django_query_analyzer.middleware.QueryAnalyzerMiddleware",
   ]
   

4. 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")),
   ]
   

5. Run the following command to create the necessary database tables for the "django_query_analyzer" package:

   python manage.py migrate
   

Usage

1. Start your Django development server:

   python manage.py runserver
   

2. 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

You can configure excluded path by configuring the PATHS_TO_EXCLUDE on the settings.py. by adding the list of path prefixes, you can ignore the execution of query analyzer on the paths. By default query analyzer execute on every paths.

Example configuration in settings.py:

PATHS_TO_EXCLUDE = ['/admin/','/swagger/']