Skip to content

Add Docs for enabled option for Java SDK #7654

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

Merged
merged 2 commits into from
Aug 18, 2023
Merged

Add Docs for enabled option for Java SDK #7654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64f9dc2
add enabled option to basic options and configuration docs
lbloder Aug 16, 2023
8a0b8b1
fix issue in enabled info
lbloder Aug 17, 2023
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
2 changes: 1 addition & 1 deletion src/platforms/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ If the callback is not set, or it returns `undefined`, the default naming scheme

</PlatformSection>

<ConfigKey name="enabled" supported={["javascript", "node"]}>
<ConfigKey name="enabled" supported={["javascript", "node", "java"]}>

Specifies whether this SDK should send events to Sentry. Defaults to `true`. Setting this to `enabled: false` doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call `Sentry.init` conditionally.

Expand Down
16 changes: 16 additions & 0 deletions src/platforms/java/common/configuration/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,22 @@ SENTRY_DEBUG=true
sentry.debug=true
```

### Disable Sentry

To disable Sentry, use the `enabled` option:

```properties {tabTitle:sentry.properties}
enabled=false
```

```properties {tabTitle:environment variable}
SENTRY_ENABLED=false
```

```properties {tabTitle:system property}
sentry.enabled=false
```

## Configuring Timeouts

It’s possible to manually set the connection timeouts length with `connectionTimeoutMillis` and `readTimeoutMillis`:
Expand Down