arq for Python
Learn about using Sentry with arq.
The arq integration adds support for the arq job queue system.
If you're using stream mode, this page's references to "transaction" should be applied to service spans instead. See Streamed Spans for more information.
Install sentry-sdk from PyPI:
pip install sentry-sdk
pip install sentry-sdk
uv add sentry-sdk
If you have the arq package in your dependencies, the arq integration will be enabled automatically when you initialize the Sentry SDK.
import sentry_sdk
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
)
import sentry_sdk
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
)
import asyncio
from arq import create_pool
from arq.connections import RedisSettings
async def main():
sentry_sdk.init(...) # same as above
redis = await create_pool(RedisSettings())
# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode
with sentry_sdk.start_transaction(name="testing_sentry"):
r = await redis.enqueue_job("add_numbers", 1, 2)
asyncio.run(main())
import asyncio
from arq import create_pool
from arq.connections import RedisSettings
async def main():
sentry_sdk.init(...) # same as above
redis = await create_pool(RedisSettings())
# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode
with sentry_sdk.start_transaction(name="testing_sentry"):
r = await redis.enqueue_job("add_numbers", 1, 2)
asyncio.run(main())
When you run run.py it will create a transaction called testing_sentry in the Performance section of sentry.io, and create a span for enqueuing the job.
It takes a couple of moments for the data to appear in sentry.io.
import sentry_sdk
from sentry_sdk.integrations.arq import ArqIntegration
sentry_sdk.init(...) # same as above
async def add_numbers(ctx, a, b):
1/0 # raises an error!
return a + b
class WorkerSettings:
functions = [add_numbers]
import sentry_sdk
from sentry_sdk.integrations.arq import ArqIntegration
sentry_sdk.init(...) # same as above
async def add_numbers(ctx, a, b):
1/0 # raises an error!
return a + b
class WorkerSettings:
functions = [add_numbers]
When you run a worker with arq demo.WorkerSettings it will create a transaction called add_numbers in the Performance section of sentry.io, and will also create and issue in Sentry and connect it to the transaction.
It takes a couple of moments for the data to appear in sentry.io.
- ARQ: 0.23+
- Python: 3.7+
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").