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 "sentry-sdk"

AsyncioIntegration works by instrumenting the current event loop, which is why it needs to be enabled when there's an event loop running.

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="___PUBLIC_DSN___",
        # 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,
        # ___PRODUCT_OPTION_START___ performance
        # Set traces_sample_rate to 1.0 to capture 100%
        # of transactions for tracing.
        traces_sample_rate=1.0,
        # ___PRODUCT_OPTION_END___ performance
        # ___PRODUCT_OPTION_START___ profiling
        # To collect profiles for all profile sessions,
        # set `profile_session_sample_rate` to 1.0.
        profile_session_sample_rate=1.0,
        # Profiles will be automatically collected while
        # there is an active span.
        profile_lifecycle="trace",
        # ___PRODUCT_OPTION_END___ profiling
        integrations=[
            AsyncioIntegration(),
        ],
    )

    # your code goes here.
    ...

asyncio.run(main())

Alternatively, if you're not in control of the event loop, you have multiple event loops, or you simply need a way to enable the integration on demand without setting up the whole SDK each time, you can use the sentry_sdk.integrations.asyncio.enable_asyncio_integration helper function.

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

# Initializing the SDK as early as possible, when there is no event loop yet
sentry_sdk.init(
    dsn="___PUBLIC_DSN___",
    # 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,
    # ___PRODUCT_OPTION_START___ performance
    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for tracing.
    traces_sample_rate=1.0,
    # ___PRODUCT_OPTION_END___ performance
    # ___PRODUCT_OPTION_START___ profiling
    # To collect profiles for all profile sessions,
    # set `profile_session_sample_rate` to 1.0.
    profile_session_sample_rate=1.0,
    # Profiles will be automatically collected while
    # there is an active span.
    profile_lifecycle="trace",
    # ___PRODUCT_OPTION_END___ profiling
    # No AsyncioIntegration in explicitly provided `integrations`
)


async def main():
    enable_asyncio_integration()  # instruments the current event loop
    # Your code...

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

main.py
Copied
import asyncio

import sentry_sdk

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.
  • By default, every executed task will be instrumented and show up in the performance waterfall on Sentry.io. This behavior can be disabled by providing the task_spans=False flag to the AsyncioIntegration() or to the enable_asyncio_integration() helper:
Copied
import sentry_sdk
from sentry_sdk.integrations.asyncio import AsyncioIntegration, enable_asyncio_integration

sentry_sdk.init(
    integrations=[AsyncioIntegration(task_spans=False)],
)

# Or:

enable_asyncio_integration(task_spans=False)

The asyncio integration isn't working.

The SDK needs the event loop to be running when instrumenting asyncio. Make sure to call sentry_sdk.init() inside of an async function.

There is no event loop when I need to initialize the SDK. How do I initialize the asyncio integration?

You can initialize the SDK without AsyncioIntegration and then run sentry_sdk.integrations.asyncio.enable_asyncio_integration() once there is an event loop running. See this section for an example.

  • 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").