- Requirements
- Installations
- API guide
{
"react-native": "^0.60.0",
"@react-native-async-storage/async-storage": "^1.13.3"
}To install the package:
npm install --save raygun4reactnative
# OR
yarn add raygun4reactnativeSince our SDK supports native crashes, we need to link the SDK to your native projects.
Modify Podfile
platform :ios, '10.0'
then run
cd ios && pod install
# OR
npx pod-install iosModify the app's android/app/src/main/AndroidManifest.xml to include the following line to enable the background Crash Reporting Service & Real-time User monitoring
<application ...>
...
<service
android:name="com.raygun.raygun4android.services.CrashReportingPostService"
android:exported="false"
android:permission="android.permission.BIND_JOB_SERVICE"
android:process=":crashreportingpostservice"
/>
<service
android:name="com.raygun.raygun4android.services.RUMPostService"
android:exported="false"
android:permission="android.permission.BIND_JOB_SERVICE"
android:process=":rumpostservice"
/>
...
</application>Crash Reporting Installation
Crash Reporting Features
Real User Monitoring Installation
Real USer Monitoring Features
The client must be instantiated and initialized before using the rest of the API. Failing to do so will result in a lack of functionality (this will be logged out to the system - this means that during testing it will appear where console.logs appear).
An instance of the RaygunClient is created by importing the client from the package.
import RaygunClient from "raygun4reactnative"This instance will be used to call action upon the rest of the API interface. Be sure to init your
instance BEFORE using the other functions within the API.
The init function must be used BEFORE doing anything else with the RaygunClient. This is
important, as all other functionality within the client will rely on the options parsed to it with
this function.
Multithreading: This function, by default, is NOT asynchronous. BEWARE, as asynchronously calling
this method may lead to some undesirable outcomes. The init method needs to finish before all
other methods.
See also:
BeforeSendHandler
LogLevel
RaygunClientOptions
import RaygunClient, {RaygunClientOptions, LogLevel} from "raygun4reactnative"
const options: RaygunClientOptions = {
apiKey: "INSERT_YOUR_API_KEY_HERE",
version: "0.1.2",
enableCrashReporting: true,
disableNativeCrashReporting: false,
disableUnhandledPromiseRejectionReporting: false,
enableRealUserMonitoring: true,
disableNetworkMonitoring: false,
customCrashReportingEndpoint: "https://myCrashReportingEndpoint.com",
customRealUserMonitoringEndpoint: "https://myRealUserMonitoringEndpoint.com",
ignoredURLs: ["http://thisIsAnInternalCall.com", "http://thisIsAnotherInternalCall.com"],
ignoredViews: ["name of view to ignore"],
logLevel: LogLevel.verbose,
onBeforeSendingCrashReport: (crashReport) => console.log(crashReport),
maxErrorReportsStoredOnDevice: 10,
maxBreadCrumbsPerErrorReport: 10,
};
RaygunClient.init(options);After successfully calling the init function, the client has been instantiated and initialized. Now the other functions provided by the client will be able to run.
The setTags function set the global tags for the Raygun client. All crash reports and real user
monitoring packages will be attached with these tags, such that they can be searched for in the
Raygun.com dashboard. To remove all tags, simply parse this method nothing.
import RaygunClient from "raygun4reactnative"
RaygunClient.setTags("Invalid_User_Entry", "Caught_Exception");
// Reset tags
RaygunClient.setTags();The getTags returns all the global tags that are currently set in the Raygun client.
Tip: To append more tags to the global set, use the get method to retrieve an array of currently
existing tags, concat the extra tags onto the list, and call the setTags function again.
import RaygunClient from "raygun4reactnative"
const globalTags: string[] = RaygunClient.getTags();The setUser function is parsed a User object. Setting the user is an important step in maintaining
a Real User Monitoring session. By updating the User, the following rules are applied:
- anonymous_user -> user_1 => Current session is updated with the user data.
- user_1 -> user_2 => Current session ends. A new session begins with user_2 information.
- user_1 -> anonymous_user => Current sessions ends. A new session begins.
Note, if null is parsed to this method, the user is set to an anonymous user.
See also:
User
import RaygunClient, {User} from "raygun4reactnative"
const user: User = {
identifier: '[email protected]',
isAnonymous: false,
email: '[email protected]',
firstName: 'Ronald',
fullName: 'Ronald Raygun',
uuid: 'uuid'
}
RaygunClient.setUser(user);
// Reset to anonymous user
RaygunClient.setUser(null);The getUser function returns the current user.
Find out more here!
See also:
User
import RaygunClient, {User} from "raygun4reactnative"
const curUser: User = RaygunClient.getUser();The recordBreadcurmb function appends a breadcrumb to the global set of breadcrumbs. These
breadcrumbs are attached to all Crash Reports. Breadcrumbs are useful when debugging code, if you
leave a trail of breadcrumbs as your code progresses, then you can determine the state of the
program right before the crash occurred.
See also:
Breadcrumb
import RaygunClient, {Breadcrumb} from "raygun4reactnative"
const breadCrumb: Breadcrumb = {
message: "Hansel and Gretel #1",
category: "FairyTales",
level: 'warning',
customData: {"House Materials": ["GingerBread", "GumDrops"]},
timestamp: Date.now(),
type: 'manual',
}
RaygunClient.recordBreadcrumb(breadCrumb);The getBreadcrumbs function returns an array of the current global set of breadcrumbs.
See also:
Breadcrumb
import RaygunClient, {Breadcrumb} from "raygun4reactnative"
const globalBreadcrumbs: Breadcrumb[] = RaygunClient.getBreadcrumbs();The clearBreadcrumbs function removes all the globally set breadcrumbs.
import RaygunClient, from "raygun4reactnative"
RaygunClient.clearBreadcrumbs();The sendError function manually sends an error to your Raygun dashboard. By default, the crash
reporter will capture all unhandled errors, and send them through to Raygun, however in some cases,
an error shouldn't be thrown as the program can still persist. If you have caught some error, you
can utilize this method, and send the error through to Raygun. Appended to this error is a
ManualCrashReportDetails object. This non-mandatory object can apply specific tags and CustomData to
the error you are sending away as well as the global tags and CustomData.
See also:
CustomData
ManualCrashReportDetails
import RaygunClient, {ManualCrashReportDetails} from "raygun4reactnative"
try {
// some action that might throw an error
throw new Error("Something went wrong");
} catch (e) {
const localDetails: ManualCrashReportDetails = {
customData: {"Local": "Tried to attempt action A, but failed"},
tags: ["Action A", "Local"]
}
RaygunClient.sendError(e, localDetails);
// Alternatively, if you don't wish to append any local data
RaygunClient.sendError(e);
}The setCustomData function will set the global custom data object to the parsed parameter. When
any error occurs, this custom data will be attached to all crash reports. If you parse null to
this function, the global custom data will be reset.
See also:
CustomData
import RaygunClient, {CustomData} from "raygun4reactnative"
const customData: CustomData = {"Key": "Value"};
RaygunClient.setCustomData(customData);
// To reset custom data object
RaygunClient.setCustomData(null);The getCustomData function will return the current, global custom data object that has been set.
If no custom data object exists, then the function will return null.
See also:
CustomData
import RaygunClient, {CustomData} from "raygun4reactnative"
const customData: CustomData | null = RaygunClient.getCustomData();The setMaxReportsStoredOnDevice function will determine how many crash reports are stored on the
device. A crash report is stored when the user is unable to connect to Raygun.com. Upon launching
the application again, the reports that are stored are attempted to be sent.
Note, although any number can be parsed through this value, the maximum amount of stored crash reports is capped at 64. The minimum is 0. Parsing 0 (or less) will mean, no crash reports are stored on the device at all. The default starting value is 64.
import RaygunClient from "raygun4reactnative"
RaygunClient.setMaxReportsStoredOnDevice(10); // Sets the amount to 10
// Alternatively
RaygunClient.setMaxReportsStoredOnDevice(100); // Sets the amount to 64
RaygunClient.setMaxReportsStoredOnDevice(-100); // Sets the amount to 0The sendRUMTimingEvent function manually sends a new timing event to Real User Monitoring. Parsing
in a
RealUserMonitoringTiming event, the name of the event, and the duration of the event. This can be
used to monitor the load times of particular components or fetch times of network requests.
By default, if Real User Monitoring is enabled, all network events are captured and sent to Raygun.
However, if you choose to disable this through the init method, then you can still send away
network timing events using this function.
See also: RealUserMonitoringTimings
import RaygunClient, {RealUserMonitoringTimings} from "raygun4reactnative"
// Monitoring some activity
RaygunClient.sendRUMTimingEvent(RealUserMonitoringTimings.ViewLoaded, 'name of the activity event', 1000);
// Monitoring a network call
RaygunClient.sendRUMTimingEvent(RealUserMonitoringTimings.NetworkCall, 'name of the network event', 255);This segment outlines the type declarations for some Raygun4ReactNative specific objects. Each of these object types can be imported into your program and used (as the examples throughout the rest of the API guide show).
The BeforeSendHandler acts as an intermediate function between your application and Raygun. This
function is parsed a CrashReportPayload and returns a CrashReportPayload or Null. Before the
CrashReportPayload is sent to Raygun, this function will be called to apply some logic to the
report. If null or other invalid object is returned, then the report is ignored (not sent to
Raygun).
See also:
CrashReportPayload
export type BeforeSendHandler = (payload: CrashReportPayload) => CrashReportPayload | null;The Breadcrumb type is a container for simple pieces of information that are used to aid with
identifying issues. These are sent away with a CrashReportPayload.
See also:
CrashReportPayload
CustomData
export type Breadcrumb = {
message: string;
category?: string;
level?: 'debug' | 'info' | 'warning' | 'error';
customData?: CustomData;
timestamp?: number;
type?: 'manual'
};The CrashReportPayload is only accessible within the BeforeSendHandler function. This reference
should aid in designing an intermediate function. It acts as a container for basic information about
some environment where a crash occurred. This may give you some insight to the error.
See also:
Breadcrumb
CustomData
Environment
RaygunStackFrame
User
export type CrashReportPayload = {
OccurredOn: Date;
Details: {
Error: {
ClassName: string;
Message: string;
StackTrace: RaygunStackFrame[];
StackString: string;
};
Environment: Environment;
Client: {
Name: string;
Version: string;
};
UserCustomData: CustomData;
Tags?: string[];
User?: User;
Breadcrumbs?: Breadcrumb[];
Version: string;
};
};The CustomData type is a restricted object that only allows for basic object types. Treat
it as though it was a JSON object to send through with your crash report.
export type CustomData = {
[key: string]: BasicType | CustomData | BasicType[] | CustomData[];
};
// For reference (this is not an available type in the API)
const BasicType = string | number | boolean;The Environment type is accessible in a BeforeSendHandler function via the CrashReportPayload
parameter. It acts as a container for all variables related to the current system environment. The
structure below should aid if this information would be helpful for a pre-sending function. Note,
this information is also available with a crash report.
export type Environment = {
UtcOffset: number;
Cpu?: string;
Architecture?: string;
ProcessorCount?: number;
OSVersion?: string;
OSSDKVersion?: string;
WindowsBoundWidth?: number;
WindowsBoundHeight?: number;
CurrentOrientation?: string;
ResolutionScale?: number;
Locale?: string;
TotalPhysicalMemory?: number;
AvailablePhysicalMemory?: number;
TotalVirtualMemory?: number;
AvailableVirtualMemory?: number;
DiskSpaceFree?: number;
DeviceName?: string;
KernelVersion?: string;
Brand?: string;
Board?: string;
DeviceCode?: string;
JailBroken?: boolean;
};The LogLevel enum is used to set the level for which the Raygun client will log issues during
runtime.
export enum LogLevel {
off = 'off',
error = 'error',
warn = 'warn',
info = 'info',
debug = 'debug',
verbose = 'verbose',
}The ManualCrashReportDetails type is used to append additional, local details to a manually sent
crash report. Note, both fields are non-mandatory, therefore you can send just tags, or just custom
data. Note, ManualCrashReportDetails is a non-mandatory parameter for the sendError method. If no
local data is being appended to the error, you can avoid sending this object all together.
See also:
sendError()
export type ManualCrashReportDetails = {
customData?: CustomData,
tags?: string[]
}The RaygunClientOptions type is used to parse information into the RaygunClient during the init
function. Each field within the object is optional, however, failing to declare a field will result
in the option defaulting to its type specific default value (except for custom end points which will
default to the Raygun application end point). It is important that your apiKey is entered here,
else all crash reports and real user monitoring events will not be logged to your Raygun dashboard,
and will instead be thrown away, and lost forever.
See also:
BeforeSendHandler
export type RaygunClientOptions = {
apiKey?: string;
version?: string;
enableCrashReporting?: boolean;
disableNativeCrashReporting?: boolean;
disableUnhandledPromiseRejectionReporting?: boolean;
enableRealUserMonitoring?: boolean;
disableNetworkMonitoring?: boolean;
customCrashReportingEndpoint?: string;
customRealUserMonitoringEndpoint?: string;
logLevel?: LogLevel;
onBeforeSendingCrashReport?: BeforeSendHandler;
ignoredURLs?: string[];
ignoredViews?: string[];
maxErrorReportsStoredOnDevice?: number;
maxBreadcrumbsPerErrorReport?: number;
};The RaygunStackFrame type is a container which maintains information found in one frame of a
StackTrace. The only access to a RaygunStackFrame is through the CrashReportPayload. This object
would only be used in a BeforeSendHandler function.
See also:
BeforeSendHandler
CrashReportPayload
export type RaygunStackFrame = {
FileName: string;
LineNumber: number;
ColumnNumber: number | null;
MethodName: string;
ClassName: string;
};The RealUserMonitoringTimings enum is a parameter in the sendRUMTimingEvent method.
See also:
sendRUMTimingEvent
export enum RealUserMonitoringTimings {
ViewLoaded = 'p',
NetworkCall = 'n'
}The User type is used to record session data, and maintain information for Real User Monitoring.
This object type is used as a parameter for the setUser method, and is returned with the getUser
method. It is also found in other objects.
export type User = {
identifier: string;
isAnonymous?: boolean;
email?: string;
firstName?: string;
fullName?: string;
uuid?: string;
};Raygun4ReactNative uses internally Raygun4Android and Raygun4Apple to capture errors on the platform framework layer.
These two platform providers are initialized by default when the Raygun4ReactNative provider is initalized.
To disable this, set disableNativeCrashReporting to false in the RaygunClientOptions.
Important
Errors happening in the platform framework layer won't be captured by Raygun unless the provider has been initialized.
You can also initialize the platform providers directly by performing the setup steps documented in each respective provider project. This ensures that the platform providers are initialized before the React Native application loads.
Setting disableNativeCrashReporting to false also disables all communication between Raygun4ReactNative and the platform providers,
therefore data like breadcrumbs or user information won't be accesible by the platform providers.