plain.querystats
On-page database query stats in development and production.
On each page, the query stats will display how many database queries were performed and how long they took.
Clicking the stats in the toolbar will show the full SQL query log with tracebacks and timings. This is even designed to work in production, making it much easier to discover and debug performance issues on production data!
It will also point out duplicate queries,
which can typically be removed by using select_related,
prefetch_related, or otherwise refactoring your code.
Installation
# settings.py
INSTALLED_PACKAGES = [
# ...
"plain.staff.querystats",
]
MIDDLEWARE = [
"plain.middleware.security.SecurityMiddleware",
"plain.sessions.middleware.SessionMiddleware",
"plain.middleware.common.CommonMiddleware",
"plain.csrf.middleware.CsrfViewMiddleware",
"plain.auth.middleware.AuthenticationMiddleware",
"plain.middleware.clickjacking.XFrameOptionsMiddleware",
"plain.staff.querystats.QueryStatsMiddleware",
# Put additional middleware below querystats
# ...
]
We strongly recommend using the plain-toolbar along with this, but if you aren't, you can add the querystats to your frontend templates with this include:
{% include "querystats/button.html" %}
Note that you will likely want to surround this with an if DEBUG or is_staff check.
To view querystats you need to send a POST request to ?querystats=store (i.e. via a <form>),
and the template include is the easiest way to do that.
Tailwind CSS
This package is styled with Tailwind CSS,
and pairs well with plain-tailwind.
If you are using your own Tailwind implementation, you can modify the "content" in your Tailwind config to include any Plain packages:
// tailwind.config.js
module.exports = {
content: [
// ...
".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
],
// ...
}
If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
plain.toolbar
The staff toolbar is enabled for every user who is_staff.
Installation
Add plaintoolbar to your INSTALLED_PACKAGES,
and the {% toolbar %} to your base template:
# settings.py
INSTALLED_PACKAGES += [
"plaintoolbar",
]
<!-- base.template.html -->
{% load toolbar %}
<!doctype html>
<html lang="en">
<head>
...
</head>
<body>
{% toolbar %}
...
</body>
More specific settings can be found below.
Tailwind CSS
This package is styled with Tailwind CSS,
and pairs well with plain-tailwind.
If you are using your own Tailwind implementation, you can modify the "content" in your Tailwind config to include any Plain packages:
// tailwind.config.js
module.exports = {
content: [
// ...
".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
],
// ...
}
If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
plain.requestlog
The request log stores a local history of HTTP requests and responses during plain work (Django runserver).
The request history will make it easy to see redirects, 400 and 500 level errors, form submissions, API calls, webhooks, and more.
Requests can be re-submitted by clicking the "replay" button.
Installation
# settings.py
INSTALLED_PACKAGES += [
"plainrequestlog",
]
MIDDLEWARE = MIDDLEWARE + [
# ...
"plainrequestlog.RequestLogMiddleware",
]
The default settings can be customized if needed:
# settings.py
DEV_REQUESTS_IGNORE_PATHS = [
"/sw.js",
"/favicon.ico",
"/staff/jsi18n/",
]
DEV_REQUESTS_MAX = 50
Tailwind CSS
This package is styled with Tailwind CSS,
and pairs well with plain-tailwind.
If you are using your own Tailwind implementation, you can modify the "content" in your Tailwind config to include any Plain packages:
// tailwind.config.js
module.exports = {
content: [
// ...
".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
],
// ...
}
If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.