django-pgactivity
django-pgactivity
makes it easy to view, filter, and kill active Postgres queries.
Some of the features at a glance:
- The pgactivity.models.PGActivity proxy model and
pgactivity
management command for querying and filtering the Postgres pg_stat_activity view. - pgactivity.context and pgactivity.middleware.ActivityMiddleware for annotating queries with application metadata, such as the request URL.
- pgactivity.cancel and pgactivity.terminate for canceling and terminating queries. The pgactivity.models.PGActivity model manager also has these methods.
- pgactivity.timeout for dynamically setting the statement timeout.
Quick Start
Basic Command Usage
Use python manage.py pgactivity
to view and filter active queries. Output looks like the following:
39225 | 0:01:32 | IDLE_IN_TRANSACTION | None | lock auth_user in access exclusiv
39299 | 0:00:15 | ACTIVE | None | SELECT "auth_user"."id", "auth_user"."password
39315 | 0:00:00 | ACTIVE | None | WITH _pgactivity_activity_cte AS ( SELECT pid
The default output attributes are:
- The process ID of the connection.
- The duration of the query.
- The state of the query (see the Postgres docs for values).
- Attached context using pgactivity.context.
- The query SQL.
Apply filters with -f
(or --filter
). Here we query for all active queries that have a duration longer than a minute:
python manage.py pgactivity -f state=ACTIVE -f 'duration__gt=1 minute'
Cancel or terminate activity with --cancel
or --terminate
. Here we terminate a query based on the process ID:
python manage.py pgactivity 39225 --terminate
Attaching Context
You can attach context to queries to better understand where they originate using pgactivity.context or by adding pgactivity.middleware.ActivityMiddleware to settings.MIDDLEWARE
. Underneath the hood, a comment is added to the SQL statement and surfaced in django-pgactivity
.
When using the middleware, the url
of the request and the method
of the request are automatically added. Here's what the output looks like when using the pgactivity
command:
39299 | 0:00:15 | ACTIVE | {"url": "/admin/", "method": "GET"} | SELECT "auth_use
Proxy Model
Use the pgactivity.models.PGActivity proxy model to query the Postgres pg_stat_activity view. The model contains most of the fields from the view, and the cancel
and terminate
methods can be applied to the queryset.
Setting the Statement Timeout
Dynamically set the SQL statement timeout of code using `pgactivity.timeout``:
import pgactivity
@pgactivity.timeout(0.5)
def my_operation():
# Any queries in this operation that take over 500 milliseconds will throw
# django.db.utils.OperationalError.
Compatibility
django-pgactivity
is compatible with Python 3.8 - 3.12, Django 3.2 - 5.0, Psycopg 2 - 3, and Postgres 12 - 16.
Next Steps
We recommend everyone first read:
- Installation for how to install the library.
After this, there are several usage guides:
- Proxy Models for an overview of the proxy models and custom queryset methods.
- Annotating Query Context for attaching application context to queries.
- Management Command for using and configuring the management command.
- Setting the Statment Timeout for setting dynamic statement timeouts.
Core API information exists in these sections:
- Settings for all available Django settings.
- Module for documentation of the
pgactivity
module and models. - Release Notes for information about every release.
- Contributing Guide for details on contributing to the codebase.