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.

Options are passed to the SentryFlutter.init method:

Copied
import 'package:flutter/widgets.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

Future<void> main() async {
  await SentryFlutter.init(
    (options) => options
      ..dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'
      ..release = 'my-project-name@2.3.12'
      ..environment = 'staging',
    appRunner: () => runApp(MyApp()),
  );
}

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.

`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

`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 try to read this value from the SENTRY_RELEASE environment variable (in the browser SDK, this will be read off of the window.SENTRY_RELEASE.id if available).

`environment`

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).

By default the SDK will try to read this value from the SENTRY_ENVIRONMENT environment variable (except for the browser SDK where this is not applicable).

`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.

This option is turned off by default.

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.

If you are using Sentry in your mobile app, read our frequently asked questions about mobile data privacy to assist with Apple App Store and Google Play app privacy details.

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.

Most SDKs will attempt to auto-discover this value.

`autoSessionTracking`

When set to true, the SDK will send session events to Sentry. This is supported in all browser SDKs, emitting one session per pageload and page navigation to Sentry. In mobile SDKs, when the app goes to the background for longer than 30 seconds, sessions are ended.

`considerInAppFramesByDefault`

Configures whether stack trace frames are considered as in app frames by default. You can use this to essentially make inAppIncludes or inAppExcludes an allow or deny list. This value is used only if Sentry can not find the origin of the frame.

If considerInAppFramesByDefault is set to true, you only need to maintain inAppExcludes.
Conversely, if considerInAppFramesByDefault is set to false, you only need to maintain inAppIncludes.

`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.

`attachViewHierarchy`

Renders a JSON representation of the entire view hierarchy of the application when an error happens and includes it as an attachment. Learn more about enriching events with the view hierarchy in our View Hierarchy documentation.

`idleTimeout`

The idle time, measured in ms, to wait until a transaction will be automatically finished. The transaction will use the end timestamp of the last finished span as the endtime for the transaction.

The default is 3000.

`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.

(New in version 6.6.0)

`captureFailedRequests`

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

(New in version 7.0.0)

For many platform SDKs integrations can be configured alongside it. On some platforms that happen as part of the init() call, in some others, different patterns apply.

`integrations`

In some SDKs, the integrations are configured through this parameter on library initialization. For more information, please see our documentation for a specific integration.

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

`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.

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.

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.

`experimental`

An optional property that configures which features are in experimental mode. This property is either an Object Type with properties or a key/value TypedDict, depending the language. Experimental features are still in-progress and may have bugs. We recognize the irony.

Suggest an edit to this page | Contribute to Docs | Report a problem

Package:: pub:sentry_flutter
Version:: 7.20.0
Repository:: https://github.com/getsentry/sentry-dart
API Documentation:: https://pub.dev/documentation/sentry_flutter/latest/

Docs

Sentry for Flutter

Distributed Tracing

Performance Monitoring

Metrics

Profiling

User Feedback

Basic Options