Connect Starlette to Bugsink
When a Starlette endpoint fails, Bugsink shows you the exception, the application frame that raised it, and the ASGI request that reached it.
This guide covers the initial setup and Starlette’s automatic capture of unhandled endpoint exceptions. You’ll connect an existing application, then make one request fail to confirm that it reaches Bugsink.
To follow along, create a Bugsink project and copy its DSN. The quickstart guide shows where to find it.
Install the SDK
Install the open-source Sentry SDK in the environment your application uses. Bugsink accepts the Sentry event protocol, so the SDK can send events directly to your Bugsink project.
python -m pip install --upgrade sentry-sdkpython -m pip install --upgrade sentry-sdk
Configure Starlette
Import the SDK and Starlette integration where you create the application:
import os import sentry_sdk from sentry_sdk.integrations.starlette import StarletteIntegrationimport os import sentry_sdk from sentry_sdk.integrations.starlette import StarletteIntegration
Initialize the SDK before creating the Starlette application. Reading the
DSN from the environment keeps it out of source control:
sentry_sdk.init( dsn=os.environ["SENTRY_DSN"], integrations=[StarletteIntegration()], )sentry_sdk.init( dsn=os.environ["SENTRY_DSN"], integrations=[StarletteIntegration()], )
Set SENTRY_DSN in the environment where the application runs:
export SENTRY_DSN=https://key@bugsink.example/1export SENTRY_DSN=https://key@bugsink.example/1
Trigger an unhandled exception
If a Starlette endpoint raises an exception and does not catch it, the integration reports it automatically. There is no SDK call inside the endpoint. To verify the setup, this checkout endpoint raises an exception when a product is missing:
async def checkout(request): sku = request.path_params["sku"] try: product = inventory[sku] except KeyError: raise ProductNotFound(f"Product {sku} is not in inventory") from None return JSONResponse({"reserved": product["name"]})async def checkout(request): sku = request.path_params["sku"] try: product = inventory[sku] except KeyError: raise ProductNotFound(f"Product {sku} is not in inventory") from None return JSONResponse({"reserved": product["name"]})
The application maps that endpoint to /checkout/{sku}:
app = Starlette( routes=[ Route("/", index), Route("/checkout/{sku}", checkout), ] )app = Starlette( routes=[ Route("/", index), Route("/checkout/{sku}", checkout), ] )
Start the application as usual, then request a product that does not exist from this endpoint:
uvicorn app:app :::bash curl http://127.0.0.1:8000/checkout/starlette-missinguvicorn app:app :::bash curl http://127.0.0.1:8000/checkout/starlette-missing
Starlette returns an HTTP 500 response and the integration reports the exception.
See the error in Bugsink
Open your Bugsink project and select the new ProductNotFound issue. Its event
points to the failing line in the endpoint and includes the GET request.
ProductNotFound
That’s it: unhandled Starlette endpoint exceptions will now be reported to Bugsink.
The integration runs around Starlette’s request handling, so your endpoints stay ordinary application code. An unhandled exception includes its Python stack, the application source frame, and the ASGI request that reached it.
If your application catches an exception itself, report it explicitly with
capture_exception().
