Android Native Options
Configure the embedded Sentry Android SDK when using .NET for Android.
When you use the .NET for Android integration, Sentry embeds the Sentry Android SDK to provide native crash reporting and other Android-specific features. The options.Native property exposes configuration for this embedded SDK.
SentrySdk.Init(options =>
{
options.Dsn = "___PUBLIC_DSN___";
// Native Android SDK options:
options.Native.AnrEnabled = true;
options.Native.EnableNdk = true;
});
These options are also available in MAUI when targeting Android.
Native.AnrEnabled
| Type | bool |
|---|---|
| Default | true |
Enables detection of Application Not Responding (ANR) events where the main thread is blocked for too long. Enabled by default.
Native.AnrReportInDebug
| Type | bool |
|---|---|
| Default | false |
Whether ANR events are reported in debug builds. Disabled by default to avoid noise during development.
Native.AnrTimeoutInterval
| Type | TimeSpan |
|---|---|
| Default | TimeSpan.FromSeconds(5) |
How long the main thread must be unresponsive before an ANR event is captured. Default is 5 seconds.
The Android SDK automatically captures breadcrumbs for various system events. Each category can be enabled or disabled independently.
Native.EnableActivityLifecycleBreadcrumbs
| Type | bool |
|---|---|
| Default | true |
Adds breadcrumbs for Activity lifecycle events (created, started, resumed, paused, stopped, destroyed).
Native.EnableAppLifecycleBreadcrumbs
| Type | bool |
|---|---|
| Default | true |
Adds breadcrumbs for App lifecycle events (foregrounded, backgrounded).
Native.EnableSystemEventBreadcrumbs
| Type | bool |
|---|---|
| Default | true |
Adds breadcrumbs for system events such as battery state changes, low memory warnings, and timezone changes.
Native.EnableUserInteractionBreadcrumbs
| Type | bool |
|---|---|
| Default | true |
Adds breadcrumbs when the user interacts with UI elements (taps, swipes, etc.).
Native.EnableAutoActivityLifecycleTracing
| Type | bool |
|---|---|
| Default | true |
Automatically creates transactions for Activity lifecycle events. Requires TracesSampleRate or TracesSampler to be configured.
Native.EnableActivityLifecycleTracingAutoFinish
| Type | bool |
|---|---|
| Default | true |
Whether transactions created for Activity lifecycle events finish automatically when the Activity is fully drawn. Requires EnableAutoActivityLifecycleTracing to be enabled.
Native.EnableUserInteractionTracing
| Type | bool |
|---|---|
| Default | false |
Automatically creates traces for user interaction events (button clicks, etc.). Disabled by default.
Native.EnableTracing
| Type | bool |
|---|---|
| Default | false |
Enables tracing features on the embedded Android SDK. When disabled, the .NET SDK still handles traces for managed code, but the native Android SDK will not create its own traces.
Native.ProfilesSampleRate
| Type | double? |
|---|---|
| Default | null |
Profiling sample rate for the native Android SDK, between 0.0 and 1.0. Disabled when null.
Native.AttachScreenshot
| Type | bool |
|---|---|
| Default | false |
Automatically attaches a screenshot when the native Android SDK captures a Java-based error or exception.
This feature is provided by the embedded Sentry Android SDK and only works for Java-based exceptions. For .NET managed code screenshots, see See Screenshots.
Native.AttachThreads
| Type | bool |
|---|---|
| Default | false |
Automatically attaches information about all threads to all logged events.
Native.EnableRootCheck
| Type | bool |
|---|---|
| Default | true |
Checks whether the device has been rooted and includes this in event context. Disable if your app store flags this check as harmful.
Native.EnableNdk
| Type | bool |
|---|---|
| Default | true |
Enables the Android NDK integration for native C/C++ crash reporting. Disable only if you don't need native crash reports and want to reduce overhead.
Native.ConnectionTimeout
| Type | TimeSpan |
|---|---|
| Default | TimeSpan.FromSeconds(5) |
Connection timeout on the HTTP connection used by the Java SDK when sending events to Sentry.
Native.ReadTimeout
| Type | TimeSpan |
|---|---|
| Default | TimeSpan.FromSeconds(5) |
Read timeout on the HTTP connection used by the Java SDK when sending events to Sentry.
Native.EnableShutdownHook
| Type | bool |
|---|---|
| Default | true |
Enables a hook that flushes events when the main Java thread shuts down, ensuring events are sent before the process exits.
Native.EnableUncaughtExceptionHandler
| Type | bool |
|---|---|
| Default | true |
Enables the handler that attaches to Java's Thread.UncaughtExceptionHandler to capture unhandled Java exceptions.
Native.PrintUncaughtStackTrace
| Type | bool |
|---|---|
| Default | false |
When enabled, prints uncaught Java error stack traces to stderr in addition to sending them to Sentry.
Native.EnableBeforeSend
| Type | bool |
|---|---|
| Default | false |
When enabled, the BeforeSend callback configured on SentryOptions will also be invoked for events that originate from the embedded Android SDK.
This is an experimental feature. The .NET and Android SDKs don't implement identical features, so some optional event properties may be lost when round-tripping between the two SDKs.
Use these methods to control which Java packages are considered "in-app" in stack traces. Note that these use Java package names, not .NET namespaces.
Native.AddInAppExclude(prefix)
| Type | method |
|---|
Excludes frames matching the given Java package prefix from being flagged as "in-app" in stack traces.
options.Native.AddInAppExclude("java.util.");
options.Native.AddInAppExclude("org.apache.logging.log4j.");
See In-App Exclude.
Native.AddInAppInclude(prefix)
| Type | method |
|---|
Includes frames matching the given Java package prefix as "in-app" in stack traces.
options.Native.AddInAppInclude("io.sentry.samples.");
See In-App Include.
Session Replay for Android is currently experimental and must be opted into.
Native.ExperimentalOptions.SessionReplay.SessionSampleRate
| Type | double? |
|---|---|
| Default | null |
Sample rate for all sessions, between 0.0 and 1.0. Set to 0.0 or leave as null to disable session replay for regular sessions.
Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate
| Type | double? |
|---|---|
| Default | null |
Sample rate for buffered replays that are triggered when an error occurs. The SDK keeps the previous minute of activity and continues until the session ends when an error is sampled.
Native.ExperimentalOptions.SessionReplay.MaskAllText
| Type | bool |
|---|---|
| Default | true |
Masks all text content in session replay recordings to protect user privacy. Enabled by default.
Native.ExperimentalOptions.SessionReplay.MaskAllImages
| Type | bool |
|---|---|
| Default | true |
Masks all images in session replay recordings to protect user privacy. Enabled by default.
For finer-grained control of masking, you can mask or unmask entire classes of VisualElement:
// Unmask all Buttons (override the default mask-all behaviour)
options.Native.ExperimentalOptions.SessionReplay.UnmaskControlsOfType<Button>();
// Or mask a specific control type that isn't masked by default
options.Native.ExperimentalOptions.SessionReplay.MaskControlsOfType<MyCustomView>();
In apps with complex UIs containing hundreds of visual controls on a single page, type-based masking may cause performance issues. In such cases, consider applying the sentry:SessionReplay.Mask XML attribute to individual controls instead.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").