Options

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.

Learn more about DSN utilization.

Allows you to specify a path to the local event- and crash-database of the Native SDK. This path will default to .sentry-native relative to the current working directory (CWD). While this is a convenient setting for development, we strongly urge you to provide an explicit database path for our production deployments. In many deployment scenarios, the path relative to the CWD will not be writable. For this reason, you should store the database in your application's user-specific data/cache directory (e.g., under %AppData%\Local on Windows, ~/Library/Application Support on macOS, or XDG_CACHE_HOME on Linux).

Turns debug mode on or off. If debug is enabled, the SDK will attempt to print out useful debugging information if something goes wrong. If you run a debug-build (NDEBUG isn't defined), it will default to true; otherwise, the default is always false. You can provide a SENTRY_DEBUG environment variable with either "0" or "1" for "off" and "on" respectively, which will override the defaults. It's generally not recommended to turn it on in production, though turning debug mode on will not cause any safety concerns. You can limit the output by setting logger_level to an appropriate level for your production use case.

Sets the release. 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 try to read this value from the SENTRY_RELEASE environment variable.

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 will try to read this value from the SENTRY_ENVIRONMENT environment variable. Otherwise, the default environment is production.

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 will be sent. If set to 0.1, only 10% of error events will be sent. Events are picked randomly.

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.

Whether Crashpad should delay application shutdown until the upload of the crash report in the crashpad_handler is complete. This is useful for deployment in Docker (Linux and Windows containers) or systemd, where the life cycle of all processes is bound by the root process (typically the application being monitored).

Controls which crash report format the native backend sends when the application crashes. This setting only affects the native backend. See Crash Reporting Modes.

Controls how much memory the native backend captures in minidumps. This setting only affects the native backend and crash reporting modes that send a minidump. See Minidump Capture Modes.

Controls whether the SDK should propagate the W3C traceparent HTTP header alongside the sentry-trace header for distributed tracing.

If your backend uses an OTel collector with tail-based sampling, see Sentry with OTel for an important interaction with this option.

Set this boolean to false to disable client reports. Client reports are a protocol feature that allows clients to send status information about themselves to Sentry. They’re currently used mainly to report outcomes for events that were never sent.

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

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

This function is called with a backend-specific event object, and can return a modified event object or nothing to skip reporting the event. In contrast to before_send, it is only called when a crash occurred. You can find detailed information concerning its usage in Filtering.

This function is called with an SDK-specific transaction event object, and can return a modified transaction event object, or sentry_value_new_null() to skip reporting the event. One way this might be used is for manual PII stripping before sending.

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

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 traces_sample_rate must be defined to enable tracing. An example can be found in the Sampling section.

This option enables the logging integration, which allows the SDK to capture logs and send them to Sentry.

This function is called with an SDK-specific log object, and can return a modified log object, or sentry_value_new_null() to drop the log.

Whether calls to sentry_log_X() expect an attributes object as the second argument, allowing users to pass in custom log attributes. An example can be found on the Logs page.

Enables or disables in-process app-hang detection. When enabled, a background watchdog thread monitors heartbeats from the watched thread. If no heartbeat is received within app_hang_timeout, an app-hang event is captured and sent to Sentry.

Must be combined with regular calls to sentry_app_hang_heartbeat() from the thread you want monitored. The first heartbeat latches the calling thread as the monitored thread; heartbeats from any other thread are ignored.

Sets the app-hang detection timeout, in milliseconds. If enable_app_hang_tracking is enabled and no heartbeat is received from the monitored thread within this window, an app-hang event is captured.