Basic Options

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first initialized.

Programmatic Configuration

In order to provide native crash support, the Sentry SDK for Unity includes platform-specific (that is, Native) SDKs, such as Android, Apple, and Native. Those SDKs share the options with which they get initialized.

The C# layer self-initializes through the use of the BeforeSceneLoad RuntimeInitializeOnLoadMethodAttribute. On desktop, the C# layer is also responsible for initializing the native SDKs.

On mobile, the native SDKs are configured and set up during build time and initialize themselves before the Unity engine. This allows us to capture bugs/crashes of the engine itself. For that reason, we rely on on the options being set in the Sentry editor configuration window and saved to Assets/Resources/Sentry/SentryOptions.asset.

To provide a way to modify options programmatically, we've added ScriptableOptionsConfiguration to the Options Config tab in the Sentry editor window.

There are two situations when a scriptable configuration object comes into play:

• Runtime Options Script is executed on each app startup, right before the managed Sentry SDK is initialized (except for Android, iOS, and macOS native layers, which are already set up by that time). An example of how this can be used is for implementing your own filtering of events using the BeforeSend callback. (This callback only runs for events coming from C# scripts.)

• Buildtime Options Script - is executed by the Unity Editor during app build. Changes you make here affect the current build and also allow you to alter native platform build-time settings (Android, iOS, macOS).

Common Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE) are read automatically.

Dsn

The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the SENTRY_DSN environment variable. If that variable also does not exist, the SDK will just not send any events.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Learn more about DSN utilization.

StackTraceMode

• Original - Default .NET stack trace format.
• Enhanced - Include async, return type, arguments, and more.

Before version 3.0.0 of the Sentry SDK for .NET, there was no special treatment for the stack trace. Sentry reported what .NET made available at runtime. This behavior now called StackTraceMode.Original. With the introduction of 3.0, a new default mode is Enhanced.

IsGlobalModeEnabled

Specifies whether to use global scope management mode. Should be true for client applications and false for server applications.

Example scenarios where it should be explicitly set to true:

• Universal Windows platform (UWP) applications
• WinForms applications
• Windows Presentation Foundation (WPF) applications
• Single user console applications

Defaults to false, unless in Blazor WASM, MAUI, Unity, or Xamarin where the default is true.

Debug

Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong with sending the event. The default is always false. It's generally not recommended to turn it on in production, though turning debug mode on will not cause any safety concerns.

DiagnosticLevel

Enabling debug mode makes the SDK generate as much diagnostic data as possible. However, if you'd prefer to lower the verbosity of the Sentry SDK diagnostics logs, configure this option to set the appropriate level:

• debug: default The most verbose mode
• info: Informational messages
• warning: Warning that something might not be right
• error: Only SDK internal errors are printed
• fatal: Only critical errors are printed

For app models that don't have a console to print to, you can customize the SDK's diagnostic logger to write to a file or to Visual Studio's debug window.

Dist

Sets the distribution of the application. Distributions are used to disambiguate build or deployment variants of the same release of an application. For example, the dist can be the build number of an Xcode build or the version code of an Android build. The dist has a max length of 64 characters.

Release

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 or the sandbox.

By default the SDK will read from Application.productName and Application.version to create the release in the format $"{Application.productName}@{Application.version}".

Environment

Sets the environment. This string is freeform and set by default. A release can be associated with more than one environment to separate them in the UI (think staging vs prod or similar).

By default, the SDK reports editor when running inside the Unity Editor. Otherwise, the default environment is production.

SampleRate

Configures the sample rate for error events, in the range of 0.0 to 1.0. The default is 1.0 which means that 100% of error events are sent. If set to 0.1 only 10% of error events will be sent. Events are picked randomly.

MaxBreadcrumbs

This variable controls the total amount of breadcrumbs that should be captured. This defaults to 100, but you can set this to any number. However, you should be aware that Sentry has a maximum payload size and any events exceeding that payload size will be dropped.

MaxCacheItems

The maximum number of envelopes to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds max-cache-items, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is 30.

AttachStacktrace

When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.

Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.

SendDefaultPii

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.

This option is turned off by default.

If you enable this option, be sure to manually remove what you don't want to send using our features for managing Sensitive Data.

ServerName

This option can be used to supply a "server name." When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server.

For ASP.NET and ASP.NET Core applications, the value will default to the server's name. For other application types, the value will default to the computer's name only when the SendDefaultPii is set to true, because the computer's name can be considered personally identifiable information (PII) in the case of a desktop or mobile application.

InAppInclude

A list of string prefixes of module names that belong to the app. This option takes precedence over in-app-exclude.

Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as inApp. The difference is visible in sentry.io, where only the "in application" frames are displayed by default.

InAppExclude

A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.

This option can be overridden using InAppInclude.

AttachScreenshot

Takes a screenshot of the application when an error happens and includes it as an attachment. Learn more about enriching events with screenshots in our Screenshots documentation.

ScreenshotQuality

The quality of the attached screenshot. It can be set to full, high, medium or low.

SendClientReports

Set this boolean to false to disable sending of client reports. Client reports are a protocol feature that let clients send status reports about themselves to Sentry. They are currently mainly used to emit outcomes for events that were never sent.

CaptureFailedRequests

Once enabled, this feature automatically captures HTTP client errors, like bad response codes, as error events and reports them to Sentry.

Hooks

These options can be used to hook the SDK in various ways to customize the reporting of events.

The callbacks you set as hooks will be called on the thread where the event happened. So you can only use thread-safe APIs and only use Unity-specific APIs after you've checked that you're on the UI thread.

BeforeSend

This function is called with an SDK-specific message or error event object, and can return a modified event object, or null to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.

By the time BeforeSend is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.

BeforeBreadcrumb

This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.

Transport Options

Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.

Transport

Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.

HttpProxy

When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate https-proxy is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the http_proxy environment variable will be picked up.

CacheDirectoryPath

Specifies a local directory used for caching payloads. When this option is enabled (that is, when the directory is set), the Sentry SDK will persist envelopes locally before sending to Sentry. This configuration option is particularly useful if you expect your application to run in environments where internet connectivity is limited.

The default value is Application.persistentDataPath. You can disable offline caching by setting it to null.

InitCacheFlushTimeout

When caching is enabled (that is, CacheDirectoryPath is set), this option controls the timeout that limits how long the SDK will attempt to flush existing cache during initialization. Note that flushing the cache involves sending the payload to Sentry in a blocking operation. Setting this option to zero means that Sentry will not attempt to flush the cache during initialization, but instead will do so when the next payload is queued up.

The default is 1 (one) second.

ShutdownTimeout

Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.

Tracing Options

EnableTracing

A boolean value, if true, transactions and trace data will be generated and captured. This will set the traces-sample-rate to the recommended default of 1.0 if traces-sample-rate is not defined. Note that traces-sample-rate and traces-sampler take precedence over this option.

TracesSampleRate

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or TracesSampler must be defined to enable tracing.

TracesSampler

A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or TracesSampleRate must be defined to enable tracing.