asyncio

Learn about the asyncio integration and how it adds support for applications the asyncio module.

The AsyncioIntegration integrates with applications doing concurrent code execution using Python's asyncio module.

Copied
pip install --upgrade 'sentry-sdk'

Add AsyncioIntegration() to your list of integrations, enable tracing and be sure to call sentry_sdk.init() at the beginning of the first async function you call, as shown in the example below.

main.py
Copied
import sentry_sdk
from sentry_sdk.integrations.asyncio import AsyncioIntegration

async def main():
    sentry_sdk.init(
        dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
        # Add data like request headers and IP for users, if applicable;
        # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info
        send_default_pii=True,
        # Set traces_sample_rate to 1.0 to capture 100%
        # of transactions for tracing.
        traces_sample_rate=1.0,
        # Set profiles_sample_rate to 1.0 to profile 100%
        # of sampled transactions.
        # We recommend adjusting this value in production.
        profiles_sample_rate=1.0,
        integrations=[
            AsyncioIntegration(),
        ],
    )

    # your code goes here.
    ...

asyncio.run(main())

Trigger an error in your code and see it show up in sentry.io.

main.py
Copied
import asyncio

import sentry_sdk
from sentry_sdk.integrations.asyncio import AsyncioIntegration

async def my_task():
    1 / 0  # raises an error!

async def main():
    sentry_sdk.init(...)  # same as above
    asyncio.create_task(my_task())

asyncio.run(main())

  • All unhandled exceptions in tasks will be captured
  • Every executed Task will be instrumented and show up in the performance waterfall on Sentry.io

  • Python: 3.7+
Previous
ASGI
Next
asyncpg
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").