Skip to main content

Request History Panel for Django Debug Toolbar

Project description

Update: History is now built into Django Debug Toolbar

Since version 3.0 of Django Debug Toolbar a built in history panel is available. More details can be found in this PR and the docs. As this functionality is being provided by the toolbar itself there will likely not be any further updates to this project (though if there are good reasons for an exception like supporting older versions of the toolbar it will be considered). Thanks to all those who've contributed to and used this project.

Request History Panel for Django Debug Toolbar

Adds a request history panel to Django Debug Toolbar for viewing stats for different requests (with the option for ajax support).

Install

pip install django-debug-toolbar-request-history

Then add the panel to DEBUG_TOOLBAR_PANELS (see the config section for more details).

Note: only Django Debug Toolbar versions 2.0 and higher are now supported. For older versions try:

pip install django-debug-toolbar-request-history==0.0.11

or for the development version:

pip install -e git+https://github.com/djsutho/django-debug-toolbar-request-history.git#egg=django-debug-toolbar-request-history

Usage

  • Click on the "Request History" panel in the toolbar to load the available requests
  • Click on the request you are interested in (on the "Time" or "Path" part of the request) to load the toolbar for that request

Notes

Due to django-debug-toolbar reliance on thread-local:

  • currently requests do not survive server reload, therefore, when using the dev server old requests will not be available after a code change is loaded
  • if you get inconsistent request history each time you click on the panel, lower your server threads to 1

Config (in settings.py)

To DEBUG_TOOLBAR_PANELS add 'ddt_request_history.panels.request_history.RequestHistoryPanel' e.g.:

DEBUG_TOOLBAR_PANELS = [
    'ddt_request_history.panels.request_history.RequestHistoryPanel',  # Here it is
    'debug_toolbar.panels.versions.VersionsPanel',
    'debug_toolbar.panels.timer.TimerPanel',
    'debug_toolbar.panels.settings.SettingsPanel',
    'debug_toolbar.panels.headers.HeadersPanel',
    'debug_toolbar.panels.request.RequestPanel',
    'debug_toolbar.panels.sql.SQLPanel',
    'debug_toolbar.panels.templates.TemplatesPanel',
    'debug_toolbar.panels.staticfiles.StaticFilesPanel',
    'debug_toolbar.panels.cache.CachePanel',
    'debug_toolbar.panels.signals.SignalsPanel',
    'debug_toolbar.panels.logging.LoggingPanel',
    'debug_toolbar.panels.redirects.RedirectsPanel',
    'debug_toolbar.panels.profiling.ProfilingPanel',
]

To change the number of stored requests add RESULTS_STORE_SIZE to DEBUG_TOOLBAR_CONFIG e.g.:

DEBUG_TOOLBAR_CONFIG = {
    'RESULTS_STORE_SIZE': 100,
}

TODO

  • Clean-up
  • Change the storage to survive server reloads (maybe use cache or session).
  • Add tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-debug-toolbar-request-history, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size django_debug_toolbar_request_history-0.1.4-py2.py3-none-any.whl (8.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page