SentryOptions

open class SentryOptions

Sentry options that can be used to configure the SDK.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard

Experimental options for new features, these options are going to be promoted to SentryOptions before GA.

Properties

Link copied to clipboard

Sets the timeout interval in milliseconds for considering an application as not responding (ANR).

Link copied to clipboard

Defines the timeout interval in milliseconds for detecting App Hangs.

Link copied to clipboard

Enables/Disables capturing screenshots before an error. Available on iOS and Android.

Link copied to clipboard

When enabled, stack traces are automatically attached to all threads logged. Stack traces are always attached to exceptions but when this is set stack traces are also sent with threads. If no threads are logged, we log the current thread automatically.

Link copied to clipboard

When enabled, all the threads are automatically attached to all logged events.

Link copied to clipboard

Enables or disables the attach view hierarchy feature when an error happened. This is only available on iOS and Android.

Link copied to clipboard

Hook that is triggered before a breadcrumb is sent to Sentry

Link copied to clipboard

Hook that is triggered before an event is sent to Sentry

Link copied to clipboard

Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong. Default is disabled.

Link copied to clipboard

Sets the minimum log level. Default is SentryLevel.DEBUG

Link copied to clipboard
var dist: String?

Sets the distribution. Think about it together with release and environment

Link copied to clipboard
var dsn: String?

The DSN tells the SDK where to send the events to. If this value is not provided, the SDK will just not send any events.

Link copied to clipboard

Controls the tracking of App Hangs capturing moments when the application becomes unresponsive for a set duration.

Link copied to clipboard

Whether to enable or disable automatic session tracking.

Link copied to clipboard

Enables or disables the feature to automatically capture HTTP client errors. This is enabled by default.

Link copied to clipboard

Whether to enable Watchdog Termination tracking or not.

Link copied to clipboard

Sets the environment. This string is freeform and not 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.

Link copied to clipboard

Experimental options for new features, these options are going to be promoted to SentryOptions before GA.

Link copied to clipboard

A list of HTTP status code ranges indicating which client errors should be captured as errors.

Link copied to clipboard

A list of HTTP request targets indicating which client errors should be captured as errors with either regex or a plain string.

Link copied to clipboard

Enables or disables ANR (Application Not Responding) tracking.

Link copied to clipboard

Options for Sentry structured logs.

Link copied to clipboard

This variable controls the max attachment size in bytes

Link copied to clipboard

This variable controls the total amount of breadcrumbs that should be captured. Default is 100.

Link copied to clipboard

Sets the ProGuard UUID for the app. This option is used to match ProGuard/R8/DexGuard mapping files to your app. The UUID is typically generated automatically during the build process and included in the AndroidManifest.xml file.

Link copied to clipboard

Sets the release. SDK will try to automatically configure a release out of the box

Link copied to clipboard

Configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0. if 1.0 is set it means that 100% of events are sent. If set to 0.1 only 10% of events will be sent. Events are picked randomly. Default is null (disabled)

Link copied to clipboard

Information about the Sentry SDK that generated this event.

Link copied to clipboard

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. Among other things, enabling this will enable automatic IP address collection on events.

Link copied to clipboard

The options for session replay. Currently available for Android and iOS.

Link copied to clipboard

The session tracking interval in millis. This is the interval to end a session if the App goes to the background.

Link copied to clipboard

Configures the sample rate as a percentage of transactions to be sent in the range of 0.0 to 1.0. if 1.0 is set it means that 100% of transactions are sent. If set to 0.1 only 10% of transactions will be sent. Transactions are picked randomly. Default is null (disabled)