Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Celery integration init docs #9955

Open
szokeasaurusrex opened this issue May 8, 2024 · 0 comments
Open

Clarify Celery integration init docs #9955

szokeasaurusrex opened this issue May 8, 2024 · 0 comments
Labels
Platform: Python Team: Web Backend SDKs team-web-sdk-backend Type: Content Issues about the contents of our docs

Comments

@szokeasaurusrex
Copy link
Member

Core or SDK?

Platform/SDK

Which part? Which one?

Python SDK (Celery integration)

Description

The docs for setting up the Python SDK's Celery integration should be rewritten to more clearly inform users that Sentry needs to be initialized from either within the celeryd_init or worker_init signals in order for Sentry to work properly when Celery is used without Django. We currently document this in the Standalone Setup section.

Suggested Solution

My proposal would be to remove the code sample that we currently provide in the Configure section.

Instead, we should instruct users to initialize Celery per the Django integration docs when they are using Celery with Django.

Then, we would provide the Standalone Setup sample for users who are using Celery alone as a queue without Django. We should remove the term "Celery standalone" from the page, since this terminology is non-standard; a Google search for "Celery standalone" yields no relevant results. Instead, we should explain that the signal-handler setup is needed when using Celery without Django.

@szokeasaurusrex szokeasaurusrex added Type: Content Issues about the contents of our docs Team: Web Backend SDKs team-web-sdk-backend Platform: Python labels May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Platform: Python Team: Web Backend SDKs team-web-sdk-backend Type: Content Issues about the contents of our docs
Projects
None yet
Development

No branches or pull requests

1 participant