You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updating react-native options metadata to include types and defaults (#15212)
## DESCRIBE YOUR PR
React-native options were missing types and defaults
Preview:
https://sentry-docs-git-react-native-options.sentry.dev/platforms/react-native/configuration/options/
## IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
Co-authored-by: Antonis Lilis <antonis.lilis@gmail.com>
Copy file name to clipboardExpand all lines: docs/platforms/react-native/configuration/options.mdx
+44-44Lines changed: 44 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENV
14
14
15
15
## Core Options
16
16
17
-
<SdkOptionname="dsn">
17
+
<SdkOptionname="dsn"type="string">
18
18
19
19
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.
20
20
@@ -24,53 +24,53 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti
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.
30
30
31
31
</SdkOption>
32
32
33
-
<SdkOptionname="dist">
33
+
<SdkOptionname="dist"type="string">
34
34
35
35
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.
36
36
37
37
</SdkOption>
38
38
39
-
<SdkOptionname="release">
39
+
<SdkOptionname="release"type="string">
40
40
41
41
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 <SandboxLinkscenario="releases">sandbox</SandboxLink>.
42
42
43
43
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).
44
44
45
45
</SdkOption>
46
46
47
-
<SdkOptionname="environment">
47
+
<SdkOptionname="environment"type="string">
48
48
49
49
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).
50
50
51
51
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).
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](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped.
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`.
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.
76
76
@@ -80,7 +80,7 @@ Grouping in Sentry is different for events with stack traces and without. As a r
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.
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.
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)
Renders a JSON representation of the entire view hierarchy of the application when an error happens and includes it as an attachment.
159
159
Learn more about enriching events with the view hierarchy in our <PlatformLinkto="/enriching-events/viewhierarchy/">View Hierarchy documentation</PlatformLink>.
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.
Once enabled, this feature automatically captures HTTP client errors, like bad response codes, as error events and reports them to Sentry.
172
172
@@ -201,7 +201,7 @@ Allows the choice of which logs are captured: `native` for logs from native code
201
201
202
202
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.
203
203
204
-
<SdkOptionname="integrations" />
204
+
<SdkOptionname="integrations"type="array"/>
205
205
206
206
In some SDKs, the integrations are configured through this parameter on library initialization. For more information, please see our documentation for a specific integration.
207
207
@@ -229,21 +229,21 @@ This can be used to disable integrations that are enabled by default if the SDK
229
229
230
230
These options can be used to hook the SDK in various ways to customize the reporting of events.
231
231
232
-
<SdkOptionname="beforeSend">
232
+
<SdkOptionname="beforeSend"type="function">
233
233
234
234
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.
235
235
236
236
By the time <PlatformIdentifiername="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 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.
243
243
244
244
</SdkOption>
245
245
246
-
<SdkOptionname="beforeBreadcrumb">
246
+
<SdkOptionname="beforeBreadcrumb"type="function">
247
247
248
248
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.
249
249
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.
@@ -254,13 +254,13 @@ The callback typically gets a second argument (called a "hint") which contains t
254
254
255
255
Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.
256
256
257
-
<SdkOptionname="transport">
257
+
<SdkOptionname="transport"type="function">
258
258
259
259
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.
260
260
261
261
</SdkOption>
262
262
263
-
<SdkOptionname="transportOptions">
263
+
<SdkOptionname="transportOptions"type="object">
264
264
265
265
Options used to configure the transport. This is an object with the following possible optional keys:
266
266
@@ -269,27 +269,27 @@ Options used to configure the transport. This is an object with the following po
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.
275
275
276
276
</SdkOption>
277
277
278
278
## Tracing Options
279
279
280
-
<SdkOptionname="tracesSampleRate">
280
+
<SdkOptionname="tracesSampleRate"type="number">
281
281
282
282
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 <PlatformIdentifiername="tracesSampler" /> must be defined to enable tracing.
283
283
284
284
</SdkOption>
285
285
286
-
<SdkOptionname="tracesSampler">
286
+
<SdkOptionname="tracesSampler"type="function">
287
287
288
288
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 <PlatformIdentifiername="tracesSampleRate" /> must be defined to enable tracing.
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.
295
295
@@ -309,21 +309,21 @@ Controls whether the SDK should propagate the W3C `traceparent` HTTP header alon
309
309
310
310
## Experimental Features
311
311
312
-
<SdkOptionname="experimental">
312
+
<SdkOptionname="experimental"type="object">
313
313
314
314
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.
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.
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.
329
329
@@ -333,55 +333,55 @@ You should follow the [guide to native initialization](/platforms/react-native/m
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.
0 commit comments