Honeybadger for React Native
Hi there! You've found Honeybadger's guide to React Native exception and error tracking. Once installed, Honeybadger will automatically report errors from your React Native application.
Getting Started
From the root directory of your React Native project:
npm install "@honeybadger-io/react-native"
cd ios && pod install
The above will download the Honeybadger React Native library and add it as a dependency of your project. The iOS step is required to properly add the library to the Xcode project through CocoaPods. Android doesn't require a separate step.
Add the following to your App.js file to initialize the Honeybadger library.
import Honeybadger from "@honeybadger-io/react-native";
export default function App() {
Honeybadger.configure("Your project API key");
// ...
}
You can log into your Honeybadger account to obtain your API key.
Usage Examples
iOS, Android, and JavaScript errors will be automatically handled by the Honeybadger React Native library, by default. But you can also use the following API to customize error handling in your application.
Honeybadger.notify(error, additionalData)
You can use the notify method to send any kind of error, exception, object, String, etc. If sending an error or exception, the Honeybadger React Native library will attempt to extract a stack trace and any relevant information that might be useful. You can also optionally provide additionalData to the notify method, as either a string or an object, to include any relevant information.
Honeybadger.setContext(context)
If you have data that you would like to include whenever an error or an exception occurs, you can provide that data using the setContext method. Provide an object as an argument. You can call setContext as many times as needed. New context data will be merged with any previously-set context data.
Honeybadger.setContext({
user_id: "123abc",
more: "some additional data",
});
Honeybadger.resetContext()
If you've used Honeybadger.setContext() to store context data, you can use Honeybadger.resetContext() to clear that data.
Honeybadger.setLogLevel(logLevel)
Sets the logging level for the Honeybadger library.
Honeybadger.setLogLevel("debug");
The following values are accepted:
| Value | Meaning |
|---|---|
| "debug" | Everything will be logged to console. |
| "warning" | Only warnings will be logged to console. |
| "error" | Only errors will be logged to console. |
The default logging level is "warning".
Source Maps
This package includes a script that will help you generate source maps for your project. To generate source maps for both iOS and Android, run the following from your project root directory.
npx honeybadger-generate-sourcemaps
The operation might take some time, as React Native needs to build production-ready bundles and their respective source map files for both iOS and Android. Upon completion, you will find the sourcemap-ios and sourcemap-android files in your project root directory. You can then upload these files to Honeybadger to view descriptive stack trace symbols in your production builds.
Example Project
The example directory contains a minimal React Native project, demonstrating the use of the Honeybadger library. To run the project, first, open App.js and enter your Honeybadger API key. Once that's done, run the following:
npm install
cd ios ; pod install ; cd -
npx react-native start
npx react-native run-ios
Package:
@honeybadger-io/react-native
Version:
5.1.6
Repository:
https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/react-native