See what your app does on every request. Tracepanel records each request, background task and command of your Python app with its SQL queries, logs and errors. It points out N+1 queries, duplicate queries and slow SQL, and names the line of code to fix. You read it in a panel on your pages and in a console.
It runs while you develop, and everything stays on your machine.
pip install tracepanelTracepanel is on only in development: when DEBUG is on, in a debug server,
or under tracepanel run. Add it to your app:
# Django: settings.py
INSTALLED_APPS += ["tracepanel.django"]# FastAPI
from fastapi import FastAPI
import tracepanel.fastapi
app = FastAPI(debug=True)
tracepanel.fastapi.install(app)# Flask, started with `flask run --debug`
from flask import Flask
import tracepanel.flask
app = Flask(__name__)
tracepanel.flask.install(app)Open a page of your app and click the badge in the corner. On a page that
loads each post's author in its own query, the panel shows
SELECT auth_user ×50 marked N+1, the line of code that ran it, and the
select_related() that turns 50 queries into one. The console at
/__tracepanel__/ holds every request, task and command the app ran.
Tracepanel also traces Celery, Dramatiq, RQ, SQLAlchemy, Strawberry, Django REST
framework, Django Ninja, Channels and htmx when they are installed. SQL you run
through a database driver without an ORM is traced too: sqlite3, psycopg,
psycopg2, asyncpg, the MySQL drivers and oracledb. So are the HTTP calls your
app makes with requests, httpx, aiohttp or boto3, and its Redis commands. It
reads the log lines you write with logging and attaches each one to the
request, task or command that wrote it. Your logging configuration stays as it
is.
For Django, pip install django-tracepanel installs the same package.
tracepanel run turns Tracepanel on for one command. The project stays as it
is:
tracepanel run python manage.py runserver # Django
tracepanel run uvicorn app.main:app # FastAPI, Starlette
tracepanel run flask --app app run # Flask
tracepanel run gunicorn app:app # Falcon
tracepanel run celery -A app worker # a workerEvery setting has a default. To change one, set it in one of these places, and a later place wins:
tracepanel.toml, or[tool.tracepanel]inpyproject.toml- the
TRACEPANELdict in Django's settings - a
TRACEPANEL_<NAME>variable, such asTRACEPANEL_SLOW_SQL_MS=50
# pyproject.toml
[tool.tracepanel]
slow_sql_ms = 50
n_plus_one_threshold = 5
ignore_paths = ["/health*", "/static/*"]tracepanel config prints each setting, its value and where it comes from.
To add your own steps to a request or a task, or to trace a script or a scheduled job:
import time
import tracepanel
@tracepanel.traced
def rebuild_index() -> None:
with tracepanel.span("index.load", source="db") as span:
time.sleep(0.01)
span.set("rows", 120)
tracepanel.event("index rebuilt", rows=120)
with tracepanel.trace("rebuild-index"):
tracepanel.set_attr("tenant", "acme", on_trace=True)
rebuild_index()span() adds a step to the current trace, and @traced does the same for a
function. trace() starts a new trace. Tracepanel stores keyword attributes
under app., so source becomes app.source. SQL, logs and errors inside a
span belong to that span. Outside development these calls do nothing, so you
can leave them in.
| Command | What it does |
|---|---|
tracepanel run <command> |
runs a command with Tracepanel on |
tracepanel dev |
runs the agent in the foreground, with the console on http://127.0.0.1:8765/ |
tracepanel config |
prints the settings in effect and where each comes from |
tracepanel clear |
deletes every stored trace, log, query, email and issue |
tracepanel mcp |
gives an AI coding agent your traces over MCP |
| Python | Django |
|---|---|
| 3.11 | 5.2 |
| 3.12, 3.13, 3.14 | 5.2, 6.0, 6.1 |
| 3.15 | 6.1 |
- tracepanel: what Tracepanel finds, how it works, privacy, and the agent this package installs
- CHANGELOG.md: what changed in each version
- CONTRIBUTING.md: developing this package
Licensed under the MIT License.