Enable debug functionality in the SDK itself

Specifies whether this SDK should send events to Sentry. Defaults to true.

Attaches stacktraces to pure capture message / log integrations

A flag enabling Sessions Tracking feature. By default, Sessions Tracking is enabled.

Send SDK Client Reports. By default, Client Reports are enabled.

The Dsn used to connect to Sentry and identify the project. If omitted, the SDK will not send any data to Sentry.

The release identifier used when uploading respective source maps. Specify this value to allow Sentry to resolve the correct source maps when processing events.

The current environment of your application (e.g. "production").

Sets the distribution for all events

List of integrations that should be installed after SDK was initialized.

A function that takes transport options and returns the Transport object which is used to send events to Sentry. The function is invoked internally when the client is initialized.

A stack parser implementation By default, a stack parser is supplied for all supported platforms

Options for the default transport that the SDK uses.

Sample rate to determine trace sampling.

0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send all traces)

Tracing is enabled if either this or tracesSampler is defined. If both are defined, tracesSampleRate is ignored.

Initial data to populate scope.

The maximum number of breadcrumbs sent with events. Defaults to 100. Values over 100 will be ignored and 100 used instead.

A global sample rate to apply to all events.

0.0 = 0% chance of a given event being sent (send no events) 1.0 = 100% chance of a given event being sent (send all events)

Maximum number of chars a single value can have before it will be truncated.

Maximum number of levels that normalization algorithm will traverse in objects and arrays. Used when normalizing an event before sending, on all of the listed attributes:

• breadcrumbs.data
• user
• contexts
• extra Defaults to 3. Set to 0 to disable.

Maximum number of properties or elements that the normalization algorithm will output in any single array or object included in the normalized event. Used when normalizing an event before sending, on all of the listed attributes:

• breadcrumbs.data
• user
• contexts
• extra Defaults to 1000

Controls how many milliseconds to wait before shutting down. The default is SDK-specific but typically around 2 seconds. Setting this too low can cause problems for sending events from command line applications. Setting it too high can cause the application to block for users with network connectivity problems.

A pattern for error messages which should not be sent to Sentry. By default, all errors will be sent.

A URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint that accepts Sentry envelopes for forwarding. This can be used to force data through a custom server independent of the type of data.

Important: This option is currently unused and will only work in the next major version of the SDK

Controls if potentially sensitive data should be sent to Sentry by default. Note that this only applies to data that the SDK is sending by default but not data that was explicitly set (e.g. by calling Sentry.setUser()). Details about the implementation are TBD.

Defaults to false.

Set of metadata about the SDK that can be internally used to enhance envelopes and events, and provide additional data about every request.

Options which are in beta, or otherwise not guaranteed to be stable.

Function to compute tracing sample rate dynamically and filter unwanted traces.

Tracing is enabled if either this or tracesSampleRate is defined. If both are defined, tracesSampleRate is ignored.

Will automatically be passed a context object of default and optional custom data. See Transaction.samplingContext and Hub.startTransaction.

A callback invoked during event submission, allowing to optionally modify the event before it is sent to Sentry.

Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return it at the end. Returning null will cause the event to be dropped.

A callback invoked when adding a breadcrumb, allowing to optionally modify it before adding it to future events.

Note that you must return a valid breadcrumb from this callback. If you do not wish to modify the breadcrumb, simply return it at the end. Returning null will cause the breadcrumb to be dropped.