Skip to content

Commit de23c1b

Browse files
sentry-junior[bot]rahulchhabriadingsdax
authored
docs(rq): remove defunct --sentry-dsn CLI flag (#17937)
The `--sentry-dsn` option has been fully removed from RQ. The previous docs showed it in the worker startup command with a comment `# only necessary for RQ < 1.0`, which was misleading — the flag doesn't exist at all in current RQ releases (not listed in [official RQ worker args](https://python-rq.org/docs/workers/)). This also fixes the circular reference loop: `python-rq.org/patterns/sentry/` now just redirects back to this page, pointing users at a flag that no longer exists. **Changes:** - Removed `--sentry-dsn` line from the worker startup command - Updated the `## The --sentry-dsn CLI option` section to clearly state the flag has been removed Reported via Sentry User Feedback. Action taken on behalf of Rahul Chhabria. --- [View Session in Sentry](https://sentry.sentry.io/traces/?project=4510944073809921&query=gen_ai.conversation.id%3A%22slack%3AC8H0BQRDJ%3A1780190386.945419%22) Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Rahul Chhabria <rahul.chhabria@sentry.io> Co-authored-by: Johannes Daxböck <johannes.daxboeck@sentry.io>
1 parent 4fe58d8 commit de23c1b

1 file changed

Lines changed: 2 additions & 5 deletions

File tree

  • docs/platforms/python/integrations/rq

docs/platforms/python/integrations/rq/index.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ Start your worker with:
6464

6565
```shell
6666
rq worker \
67-
-c mysettings \ # module name of mysettings.py
68-
--sentry-dsn="___PUBLIC_DSN___" # only necessary for RQ < 1.0
67+
-c mysettings # module name of mysettings.py
6968
```
7069

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

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

197-
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.
198-
199-
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.
196+
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.
200197

201198
## Supported Versions
202199

0 commit comments

Comments
 (0)