Skip to content

fix: React native docs #11633

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

Closed
wants to merge 1 commit into from
Closed

fix: React native docs #11633

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
24 changes: 7 additions & 17 deletions docs/platforms/react-native/tracing/instrumentation/react-native-navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ import { Navigation } from 'react-native-navigation';
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
Sentry.reactNativeNavigationIntegration({
navigation: Navigation,
}),
],
new Sentry.ReactNativeTracing({
routingInstrumentation: navigationIntegration,
}),
],
})
```

Expand All @@ -29,26 +29,16 @@ Sentry.init({
You can configure the instrumentation by passing an options object to the constructor:

```javascript
Sentry.reactNativeNavigationIntegration({
navigation: Navigation, // Navigation from `react-native-navigation`
routeChangeTimeoutMs: 1_000, // default: 1_000
enableTabsInstrumentation: true, // default: false
ignoreEmptyBackNavigationTransactions: true, // default: true
const navigationIntegration = new Sentry.ReactNavigationInstrumentation({
Copy link
Contributor

@coolguyzone coolguyzone Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @wsdt, thanks for contributing!

I noticed in the code example there is an option for enableTimeToInitialDisplay, but in the list of options below it provides an explanation for enableTabsInstrumentation which is not in the code sample. Is this correct?

enableTimeToInitialDisplay: true,
routeChangeTimeoutMs: 1_000, // default: 1_000
});
```

### navigation

This option is required and should be the `Navigation` object imported from the navigation library.

### routeChangeTimeoutMs

This option specifies how long the instrumentation will wait for the route to mount after a change has been initiated before the transaction is discarded. The default value is `1_000`.

### enableTabsInstrumentation

This instrumentation will create a transaction on tab change. By default, only navigation commands create transactions. The default value is `false`.

### ignoreEmptyBackNavigationTransactions

This ensures that transactions that are from routes that've been seen and don't have any spans, are not being sampled. This removes a lot of clutter, making it so that most back navigation transactions are now ignored. The default value is `true`.
Loading