Skip to content

Updating react-native options metadata to include types and defaults #15212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updating react-native options metadata to include types and defaults #15212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 44 additions & 44 deletions docs/platforms/react-native/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_order: 1

Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<SdkOption name="dsn">
<SdkOption name="dsn" type="string">

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.

Expand All @@ -22,53 +22,53 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti

</SdkOption>

<SdkOption name="debug">
<SdkOption name="debug" type="boolean" defaultValue="false">

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.

</SdkOption>

<SdkOption name="dist">
<SdkOption name="dist" type="string">

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.

</SdkOption>

<SdkOption name="release">
<SdkOption name="release" type="string">

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](/product/releases/) or the <SandboxLink scenario="releases">sandbox</SandboxLink>.

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

</SdkOption>

<SdkOption name="environment">
<SdkOption name="environment" type="string">

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

</SdkOption>

<SdkOption name="sampleRate">
<SdkOption name="sampleRate" type="number" defaultValue="1.0">

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.

</SdkOption>

<SdkOption name="maxBreadcrumbs">
<SdkOption name="maxBreadcrumbs" type="number" defaultValue="100">

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](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped.

</SdkOption>

<SdkOption name="maxCacheItems">
<SdkOption name="maxCacheItems" type="number" defaultValue="30">

The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/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 `maxCacheItems`, 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`.

</SdkOption>

<SdkOption name="attachStacktrace">
<SdkOption name="attachStacktrace" type="boolean" defaultValue="true">

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.

Expand All @@ -78,7 +78,7 @@ Grouping in Sentry is different for events with stack traces and without. As a r

</SdkOption>

<SdkOption name="sendDefaultPii">
<SdkOption name="sendDefaultPii" type="boolean" defaultValue="false">

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

Expand All @@ -94,55 +94,55 @@ If you enable this option, be sure to manually remove what you don't want to sen

</SdkOption>

<SdkOption name="ignoreErrors">
<SdkOption name="ignoreErrors" type="array">

<Include name="platforms/configuration/options/ignore-errors.mdx" />

</SdkOption>

<SdkOption name="ignoreTransactions">
<SdkOption name="ignoreTransactions" type="array">

<Include name="platforms/configuration/options/ignore-transactions.mdx" />

</SdkOption>

<SdkOption name="denyUrls">
<SdkOption name="denyUrls" type="array">

<Include name="platforms/configuration/options/deny-urls.mdx" />

</SdkOption>

<SdkOption name="allowUrls">
<SdkOption name="allowUrls" type="array">

<Include name="platforms/configuration/options/allow-urls.mdx" />

</SdkOption>

<SdkOption name="autoSessionTracking">
<SdkOption name="autoSessionTracking" type="boolean" defaultValue="true">

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.

</SdkOption>

<SdkOption name="maxValueLength">
<SdkOption name="maxValueLength" type="number" defaultValue="250">

Maximum number of characters a single value can have before it will be truncated (defaults to `250`).

</SdkOption>

<SdkOption name="normalizeDepth">
<SdkOption name="normalizeDepth" type="number" defaultValue="3">

Sentry SDKs normalize any contextual data to a given depth. Any data beyond this depth will be trimmed and marked using its type instead (`[Object]` or `[Array]`), without walking the tree any further. By default, walking is performed three levels deep.

</SdkOption>

<SdkOption name="normalizeMaxBreadth">
<SdkOption name="normalizeMaxBreadth" type="number" defaultValue="1000">

This is the maximum number of properties or entries that will be included in any given object or array when the SDK is normalizing contextual data. Any data beyond this depth will be dropped. (defaults to 1000)

</SdkOption>

<SdkOption name="attachScreenshot">
<SdkOption name="attachScreenshot" type="boolean" defaultValue="false">

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 <PlatformLink to="/enriching-events/screenshots/">Screenshots documentation</PlatformLink>.
Expand All @@ -151,20 +151,20 @@ _(New in version 4.11.0)_

</SdkOption>

<SdkOption name="attachViewHierarchy">
<SdkOption name="attachViewHierarchy" type="boolean" defaultValue="false">

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 <PlatformLink to="/enriching-events/viewhierarchy/">View Hierarchy documentation</PlatformLink>.

</SdkOption>

<SdkOption name="enabled">
<SdkOption name="enabled" type="boolean" defaultValue="true">

Specifies whether this SDK should send events to Sentry. Defaults to `true`. Setting this to `enabled: false` doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call `Sentry.init` conditionally.

</SdkOption>

<SdkOption name="enableCaptureFailedRequests">
<SdkOption name="enableCaptureFailedRequests" type="boolean" defaultValue="false">

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

Expand All @@ -176,7 +176,7 @@ _(New in version 5.3.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.

<SdkOption name="integrations" />
<SdkOption name="integrations" type="array" />

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

Expand Down Expand Up @@ -204,21 +204,21 @@ This can be used to disable integrations that are enabled by default if the SDK

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

<SdkOption name="beforeSend">
<SdkOption name="beforeSend" type="function">

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 <PlatformIdentifier name="beforeSend" /> is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.

</SdkOption>

<SdkOption name="beforeSendTransaction">
<SdkOption name="beforeSendTransaction" type="function">

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

</SdkOption>

<SdkOption name="beforeBreadcrumb">
<SdkOption name="beforeBreadcrumb" type="function">

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.
Expand All @@ -229,13 +229,13 @@ The callback typically gets a second argument (called a "hint") which contains t

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

<SdkOption name="transport">
<SdkOption name="transport" type="function">

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.

</SdkOption>

<SdkOption name="transportOptions">
<SdkOption name="transportOptions" type="object">

Options used to configure the transport. This is an object with the following possible optional keys:

Expand All @@ -244,27 +244,27 @@ Options used to configure the transport. This is an object with the following po

</SdkOption>

<SdkOption name="shutdownTimeout">
<SdkOption name="shutdownTimeout" type="number" defaultValue="2000">

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.

</SdkOption>

## Tracing Options

<SdkOption name="tracesSampleRate">
<SdkOption name="tracesSampleRate" type="number">

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 <PlatformIdentifier name="tracesSampler" /> must be defined to enable tracing.

</SdkOption>

<SdkOption name="tracesSampler">
<SdkOption name="tracesSampler" type="function">

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 <PlatformIdentifier name="tracesSampleRate" /> must be defined to enable tracing.

</SdkOption>

<SdkOption name="tracePropagationTargets">
<SdkOption name="tracePropagationTargets" type="array">

An optional property that controls which downstream services receive tracing data, in the form of a `sentry-trace` and a `baggage` header attached to any outgoing HTTP requests.

Expand All @@ -278,21 +278,21 @@ If <PlatformIdentifier name="tracePropagationTargets" /> is not provided, trace

## Experimental Features

<SdkOption name="experimental">
<SdkOption name="experimental" type="object">

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.

</SdkOption>

## Hybrid SDK Options

<SdkOption name="enableNative">
<SdkOption name="enableNative" type="boolean" defaultValue="true">

Set this boolean to `false` to disable the native SDK. This will disable all native crash and error handling and, instead, the SDK will only capture errors on the upper layer.

</SdkOption>

<SdkOption name="autoInitializeNativeSdk">
<SdkOption name="autoInitializeNativeSdk" type="boolean" defaultValue="true">

Set this boolean to `false` to disable the auto initialization of the native layer SDK. Doing so means you will need to initialize the native SDK manually. Do not use this to disable the native layer.

Expand All @@ -302,55 +302,55 @@ You should follow the [guide to native initialization](/platforms/react-native/m

</SdkOption>

<SdkOption name="enableNativeCrashHandling">
<SdkOption name="enableNativeCrashHandling" type="boolean" defaultValue="true">

Set this boolean to `false` to disable hard crash handling from the native layer. Doing so means that the SDK won't capture events for hard crashes on Android and iOS if the error was caused by native code.

</SdkOption>

<SdkOption name="enableNativeNagger">
<SdkOption name="enableNativeNagger" type="boolean" defaultValue="true">

Set this boolean to `false` to disable the native nagger alert being shown.

</SdkOption>

<SdkOption name="enableAutoSessionTracking">
<SdkOption name="enableAutoSessionTracking" type="boolean" defaultValue="true">

Set this boolean to `false` to disable the [release health](/product/releases/health/) feature.

</SdkOption>

<SdkOption name="sessionTrackingIntervalMillis">
<SdkOption name="sessionTrackingIntervalMillis" type="number" defaultValue="30000">

Set this to change the default interval to end a session (release health) if the app goes to the background. Default is 30,000.

</SdkOption>

<SdkOption name="enableNdkScopeSync">
<SdkOption name="enableNdkScopeSync" type="boolean" defaultValue="true">

Set this boolean to `false` to disable the scope sync from Java to NDK on Android.

</SdkOption>

<SdkOption name="attachThreads">
<SdkOption name="attachThreads" type="boolean" defaultValue="false">

Set this boolean to `true` to automatically attach all threads to all logged events on Android.

</SdkOption>

<SdkOption name="enableAutoPerformanceTracing">
<SdkOption name="enableAutoPerformanceTracing" type="boolean" defaultValue="true">

Set this boolean to `false` to disable auto [performance monitoring](/product/insights/) tracking.

</SdkOption>

<SdkOption name="enableWatchdogTerminationTracking">
<SdkOption name="enableWatchdogTerminationTracking" type="boolean" defaultValue="true">

Set this boolean to `false` to disable [out of memory](/platforms/apple/guides/ios/configuration/out-of-memory/) tracking on iOS.

</SdkOption>

<SdkOption name="onReady">
<SdkOption name="onReady" type="function">

Set this callback, which is called after the Sentry React Native SDK initializes its Native SDKs (Android and iOS).

Expand Down
Loading