Telescope integrations

from nexus.telescope import …

Telescope for Python web frameworks and task queues.

• TelescopeWSGIMiddleware — any WSGI app (Flask, Pyramid, Bottle, Falcon…)
• TelescopeASGIMiddleware — any ASGI app (FastAPI, Starlette, Quart, Litestar…)
• DjangoTelescopeMiddleware — Django (plus ORM queries and model signals)
• instrument_flask — names Flask routes and captures their exceptions
• instrument_celery — Celery tasks as jobs that join the dispatching trace

TelescopeWSGIMiddlewareCopy Anchor Link

app.wsgi_app = TelescopeWSGIMiddleware(app.wsgi_app, telescope).

TelescopeWSGIMiddlewareCopy Anchor Link

TelescopeWSGIMiddleware(app, telescope=None)

Parameters

TelescopeASGIMiddlewareCopy Anchor Link

app.add_middleware(TelescopeASGIMiddleware) (FastAPI/Starlette) or app = TelescopeASGIMiddleware(app).

TelescopeASGIMiddlewareCopy Anchor Link

TelescopeASGIMiddleware(app, telescope=None)

Parameters

DjangoTelescopeMiddlewareCopy Anchor Link

Add "nexus.telescope.integrations.DjangoTelescopeMiddleware" FIRST in MIDDLEWARE. Records the request, every ORM query (with N+1 detection), model saves/deletes, exceptions and logs. Configure with NEXUS = {...} in settings (TELESCOPE sub-dict for Telescope options).

DjangoTelescopeMiddlewareCopy Anchor Link

DjangoTelescopeMiddleware(get_response)

Parameters

process_exception()Copy Anchor Link

def process_exception(request, exception) -> None

Parameters

FunctionsCopy Anchor Link

instrument_flask()Copy Anchor Link

def instrument_flask(app, telescope=None) -> Any

instrument_flask(app): wraps app.wsgi_app and adds route names, the parsed body, the user (flask-login) and exception capture.

Parameters

Returns Any

instrument_celery()Copy Anchor Link

def instrument_celery(telescope=None) -> None

Celery tasks as Telescope jobs. Call once, e.g. in your celery.py.

Publishing a task records a job entry in the current journey and puts a traceparent in the message headers; the worker's run joins that trace.

Parameters