Add Docs for enabled option for Java SDK (#7654)

getsentry · Aug 18, 2023 · 91d4466 · 91d4466 · vercel · Aug 18, 2023
1 parent aae383f
commit 91d4466
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx
@@ -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.
 

diff --git a/src/platforms/java/common/configuration/index.mdx b/src/platforms/java/common/configuration/index.mdx
@@ -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`: