Tracking Touch Events

(New in version 1.5.0)

To track touch events with the React Native SDK, you will need at least version 1.5.0 and will have to wrap your app with a TouchEventBoundary. You can track touch events in two ways:

Wrapping with TouchEventBoundary

At the root of your app, usually App.js, wrap the app component with Sentry.TouchEventBoundary:

import * as Sentry from "@sentry/react-native";

const App = () => {
  return (
    <Sentry.TouchEventBoundary>
      <RestOfTheApp />
    </Sentry.TouchEventBoundary>
  );
};

export default AppRegistry.registerComponent("Your Amazing App", () => App);

Using the withTouchEventBoundary Higher-Order Component

At the root of your app, usually App.js, wrap the app component with Sentry.withTouchEventBoundary:

import * as Sentry from "@sentry/react-native";

const App = () => {
  return <RestOfTheApp />;
};

export default AppRegistry.registerComponent("Your Amazing App", () =>
  Sentry.withTouchEventBoundary(App)
);

How Touches are Tracked Automatically

Each touch event that occurs will be automatically logged as a breadcrumb, and will be displayed on the dashboard when an event occurs along with the component tree that the touch event occurred in. This component tree is logged using the name property of a component. By default, React Native will set this property automatically on components.

Tracking Specific Components

You can let Sentry know which components to specifically track by setting the displayName property on them. If Sentry detects a component with a displayName within a touch's component tree, it will be logged nicely on the dashboard as having occurred in that component.

class YourCoolComponent extends React.Component {
  static displayName = "CoolComponent";
  render() {
    return <View>{/* ... */}</View>;
  }
}

or

const YourCoolComponent = props => {
  return <View>{/* ... */}</View>;
};

YourCoolComponent.displayName = "CoolComponent";

Options

You can pass specific options to configure the boundary either as props to the Sentry.TouchEventBoundary component or as the second argument to the Sentry.withTouchEventBoundary higher-order component (HOC).

<Sentry.TouchEventBoundary
  ignoreNames={["BadComponent", /^Connect\(/, /^LibraryComponent$/]}
>
  <RestOfTheApp />
</Sentry.TouchEventBoundary>

breadcrumbCategory

string

The category assigned to the breadcrumb that is logged by the touch event.

breadcrumbType

string

The type assigned to the breadcrumb that is logged by the touch event.

maxComponentTreeSize

number

The max number/depth of components to display when logging a touch's component tree. The default is 20.

ignoreNames

Array<string | RegExp>

(New in version 1.7.0) Component names to ignore when logging the touch event. This prevents unhelpful logs such as "Touch event within element: View" where you still can't tell which View it occurred in. Accepts strings and regular expressions.

Production Bundles

When bundling for production, React Native will minify class and function names to reduce the bundle size. This means that you won't get the full original component names in your Touch Event breadcrumbs. A way to work with this is to set the displayName on all the components you want to track. However, you can also configure Metro bundler to not minify function names by setting these options in metro.config.js:

module.exports = {
  transformer: {
    minifierConfig: {
      keep_classnames: true, // Preserve class names
      keep_fnames: true, // Preserve function names
      mangle: {
        keep_classnames: true, // Preserve class names
        keep_fnames: true, // Preserve function names
      },
    },
  },
};