Skip to content

docs(rq): remove defunct --sentry-dsn CLI flag #17937

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.

Sign up for GitHub

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

Open
sentry-junior wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −5
Open

docs(rq): remove defunct --sentry-dsn CLI flag #17937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions docs/platforms/python/integrations/rq/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ Start your worker with:

```shell
rq worker \
-c mysettings \ # module name of mysettings.py
--sentry-dsn="___PUBLIC_DSN___" # only necessary for RQ < 1.0
-c mysettings # module name of mysettings.py
```

The integration will automatically report errors from all RQ jobs.
Expand Down Expand Up @@ -194,9 +193,7 @@ It takes a couple of moments for the data to appear in [sentry.io](https://sentr

## The `--sentry-dsn` CLI option

Passing `--sentry-dsn=""` to RQ forcibly disables [RQ's shortcut for using Sentry](https://python-rq.org/patterns/sentry/). For RQ versions before 1.0 this is necessary to avoid conflicts, because back then RQ would attempt to use the `raven` package instead of this SDK. Since RQ 1.0 it's possible to use this CLI option and the associated RQ settings for initializing the SDK.

We still recommend against using those shortcuts because it would be harder to provide options to the SDK at a later point. See [the GitHub issue about RQ's Sentry integration](https://github.com/rq/rq/issues/1003) for discussion.
The `--sentry-dsn` CLI option has been removed from RQ. Initialize the Sentry SDK directly in your worker settings file (e.g. `mysettings.py`) as shown above.

## Supported Versions

Expand Down
Loading