Skip to content

Commit 4edff18

Browse files
authored
Document current behavior (#15)
* document current behavior * Mention outer try/except to avoid double sentry
1 parent 02d563e commit 4edff18

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ status 0 if events are able to be sent to Sentry.
88
It reads its configuration from the environment variable `$SHELL_SENTRY_DSN`
99
and, if such a variable is found, removes it from the environment before
1010
calling the wrapped program. If that environment variable is not present, shentry will look
11-
for `$SENTRY_DSN`. If neither of the environment variables are present or btoh
11+
for `$SENTRY_DSN` (and similarly remove it from the environment).
12+
If you need to use SENTRY_DSN inside your project code, make sure to set both.
13+
You may also in that case want to put a top-level try/except around your whole
14+
program to prevent uncaught exceptions from trigging both your in-process sentry sdk
15+
and also your extra-process shentry, since you very likely only want one or the other.
16+
If neither of the environment variables are present or both
1217
are empty, shentry will try to read a DSN from `/etc/shentry_dsn`. If no DSN
1318
can be found, the wrapped will have normal behavior (stdout/stderr will go
1419
to their normal file descriptors, exit code will be passed through, etc).

0 commit comments

Comments
 (0)