SDKOtions migration #15171
Open
SDKOtions migration #15171
+1,007
−909
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
October 8, 2025 19:03
- Convert all ConfigKey components to SdkOption across 18 files - Transform option names to platform-native casing: - camelCase: Android, React Native, Java, Kotlin, Apple, Dart/Flutter - PascalCase: Unreal, Unity, .NET, PowerShell - snake_case: Godot, Native/C++, Elixir - Add metadata (type, defaultValue, envVar, availableSince) where applicable - Add TableOfContents components to main options pages - Preserve PlatformSection wrappers for platform-specific options - Update PlatformIdentifier references to use native casing This migration improves documentation UX with: - Consistent metadata presentation across all SDK docs - Better visual hierarchy with metadata tables - Platform-specific naming conventions - Enhanced discoverability with table of contents
- Replace ConfigKey documentation with SdkOption in components guide - Add comprehensive SdkOption attributes and usage examples - Include platform-native casing guidelines (camelCase, PascalCase, snake_case) - Update configuration writing guide with SdkOption best practices - Document categorySupported/categoryNotSupported usage - Add guidance on metadata attributes and TableOfContents component - Clarify PlatformIdentifier component usage for dynamic case transformation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Bundle ReportChanges will increase total bundle size by 12.92kB (0.05%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
- Convert kebab-case PlatformIdentifier names to PascalCase in Unity - in-app-include → InAppInclude - set-before-send → SetBeforeSend - set-before-send-transaction → SetBeforeSendTransaction - cache-directory-path → CacheDirectoryPath - traces-sampler → TracesSampler - traces-sample-rate → TracesSampleRate - Convert kebab-case PlatformIdentifier names to PascalCase in PowerShell - before-send → BeforeSend - cache-directory-path → CacheDirectoryPath - traces-sampler → TracesSampler - traces-sample-rate → TracesSampleRate This ensures PlatformIdentifier references match the platform-native casing used in their corresponding SdkOption name attributes.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…le platforms Convert all remaining kebab-case PlatformIdentifier names to platform-native casing: Java (camelCase): - in-app-includes → inAppIncludes - send-default-pii → sendDefaultPii - before-send → beforeSend - traces-sampler → tracesSampler - traces-sample-rate → tracesSampleRate - trace-propagation-targets → tracePropagationTargets .NET (PascalCase): - in-app-include → InAppInclude - set-before-send → SetBeforeSend - set-before-send-transaction → SetBeforeSendTransaction - cache-directory-path → CacheDirectoryPath - traces-sampler → TracesSampler - traces-sample-rate → TracesSampleRate Kotlin (camelCase): - before-send → beforeSend - traces-sampler → tracesSampler - traces-sample-rate → tracesSampleRate - trace-propagation-targets → tracePropagationTargets Apple (camelCase): - in-app-include → inAppInclude - before-send → beforeSend - traces-sampler → tracesSampler - traces-sample-rate → tracesSampleRate - trace-propagation-targets → tracePropagationTargets Dart (camelCase): - in-app-include → inAppInclude - before-send → beforeSend - traces-sampler → tracesSampler - traces-sample-rate → tracesSampleRate - trace-propagation-targets → tracePropagationTargets All PlatformIdentifier references now match their corresponding SdkOption name attributes with consistent platform-native casing.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Native (snake_case): - before-send → before_send - traces-sampler → traces_sampler - traces-sample-rate → traces_sample_rate Unreal (PascalCase): - before-send → BeforeSend - traces-sampler → TracesSampler - traces-sample-rate → TracesSampleRate All PlatformIdentifier references now use platform-native casing.
Lms24
approved these changes
Oct 9, 2025
There was a problem hiding this comment.
LGTM from my end!
As a follow up, i think we should add the type and default value annotation to the individual docs and SDK options. If this is something the docs/DevEx team will take over, I recommend making PRs per language and tagging people from the respective SDK teams for reviews.
JoshuaMoelans
approved these changes
Oct 9, 2025
Comment on lines
+67
to
68
| </SdkOption> | ||
|
|
There was a problem hiding this comment.
I just added a new option for Native this morning (see https://github.com/getsentry/sentry-docs/blame/master/docs/platforms/native/common/configuration/options.mdx#L67-L71) which could use the same ConfigKey->SdkOption treatment
| </SdkOption> | ||
|
|
||
| <ConfigKey name="debug"> | ||
| <SdkOption name="debug" type="bool" envVar="SENTRY_DEBUG"> |
There was a problem hiding this comment.
Suggested change
| <SdkOption name="debug" type="bool" envVar="SENTRY_DEBUG"> | |
| <SdkOption name="debug" type="bool" envVar="SENTRY_DEBUG" defaultValue="false"> |
| </SdkOption> | ||
|
|
||
| <ConfigKey name="crashpad-wait-for-upload"> | ||
| <SdkOption name="crashpad_wait_for_upload" type="bool"> |
There was a problem hiding this comment.
Suggested change
| <SdkOption name="crashpad_wait_for_upload" type="bool"> | |
| <SdkOption name="crashpad_wait_for_upload" type="bool" defaultValue="false"> |
| ## Tracing Options | ||
|
|
||
| <ConfigKey name="traces-sample-rate"> | ||
| <SdkOption name="traces_sample_rate" type="float"> |
There was a problem hiding this comment.
Suggested change
| <SdkOption name="traces_sample_rate" type="float"> | |
| <SdkOption name="traces_sample_rate" type="float" defaultValue="0.0"> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Closing Linear Project on the subject, this converts all
ConfigKeystyling toSDKOptionstyling.Mobile SDKs
Android: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/android/configuration/options/
React Native: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/react-native/configuration/options/
Flutter: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/flutter/configuration/options/
Dart: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/dart/configuration/options/
Apple Platforms
iOS: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/apple/guides/ios/configuration/options/
macOS: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/apple/guides/macos/configuration/options/
Game Engines
Unity: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/unity/configuration/options/
Unity CLI Options: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/unity/configuration/options/cli-options/
Unity View Hierarchy: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/unity/enriching-events/view-hierarchy/
Unreal: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/unreal/configuration/options/
Godot: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/godot/configuration/options/
Server SDKs
Java: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/java/configuration/options/
Kotlin Multiplatform: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/kotlin/guides/kotlin-multiplatform/configuration/options/
.NET: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/dotnet/configuration/options/
.NET MSBuild: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/dotnet/configuration/msbuild/
Native (C/C++): https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/native/configuration/options/
Elixir Logging: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/elixir/configuration/logging/
PowerShell: https://sentry-docs-git-sdkoptions-migration.sentry.dev/platforms/powershell/configuration/options/
Contributor Documentation
Components Guide: https://sentry-docs-git-sdkoptions-migration.sentry.dev/contributing/pages/components/
Write Configuration Guide: https://sentry-docs-git-sdkoptions-migration.sentry.dev/contributing/approach/sdk-docs/write-configuration/
It also updates the instructions about styling for the docs repo.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: