Skip to content

docs(java-sdk): refactor config options page #12692

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

docs(java-sdk): refactor config options page #12692

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3739de4
docs(java-sdk): refactor config options page
stephanie-anderson Feb 12, 2025
40026d1
[getsentry/action-github-commit] Auto commit
getsantry[bot] Feb 12, 2025
f571e62
improve java options docs (#12738)
adinauer Mar 6, 2025
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 docs/platforms/android/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/dart/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/dotnet/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/flutter/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
161 changes: 83 additions & 78 deletions docs/platforms/java/common/configuration/options.mdx
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/platforms/kotlin/guides/kotlin-multiplatform/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/native/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Turns debug mode on or off. If `debug` is enabled, the SDK will attempt to print

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/powershell/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the identifier for the version of the currently running application. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/react-native/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Sets the distribution of the application. Distributions are used to disambiguate

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/unreal/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Turns debug mode on or off. If debug is enabled SDK will attempt to print out us

Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the releases documentation](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable (in the browser SDK, this will be read off of the `window.SENTRY_RELEASE.id` if available).
By default the SDK will try to read this value from the `SENTRY_RELEASE` environment variable.

</ConfigKey>

Expand Down
90 changes: 46 additions & 44 deletions src/components/sdkOption/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,52 +48,54 @@ export function SdkOption({
</a>
</h3>
<div className={styles['sdk-config-option-details']}>
<table className={styles['sdk-option-table']}>
<tbody>
{type && (
<tr>
<th>Type</th>
<td>
<code>{type}</code>
</td>
</tr>
)}
{defaultValue && (
<tr>
<th>Default</th>
<td>
<code>{defaultValue}</code>
</td>
</tr>
)}
<PlatformCategorySection supported={['server', 'serverless']}>
<PlatformSection notSupported={['javascript.nextjs']}>
{envVar && (
<tr>
<th>ENV Variable</th>
<td>
<code>{envVar}</code>
</td>
</tr>
)}
</PlatformSection>
</PlatformCategorySection>
{(type || defaultValue || envVar || showBrowserOnly || showServerLikeOnly) && (
<table className={styles['sdk-option-table']}>
<tbody>
{type && (
<tr>
<th>Type</th>
<td>
<code>{type}</code>
</td>
</tr>
)}
{defaultValue && (
<tr>
<th>Default</th>
<td>
<code>{defaultValue}</code>
</td>
</tr>
)}
<PlatformCategorySection supported={['server', 'serverless']}>
<PlatformSection notSupported={['javascript.nextjs']}>
{envVar && (
<tr>
<th>ENV Variable</th>
<td>
<code>{envVar}</code>
</td>
</tr>
)}
</PlatformSection>
</PlatformCategorySection>

{showBrowserOnly && (
<tr>
<th>Only available on</th>
<td>Client</td>
</tr>
)}
{showBrowserOnly && (
<tr>
<th>Only available on</th>
<td>Client</td>
</tr>
)}

{showServerLikeOnly && (
<tr>
<th>Only available on</th>
<td>Server</td>
</tr>
)}
</tbody>
</table>
{showServerLikeOnly && (
<tr>
<th>Only available on</th>
<td>Server</td>
</tr>
)}
</tbody>
</table>
)}

{children}
</div>
Expand Down
Loading