Installation

Raygun provides crash reporting and error monitoring for iOS, tvOS & macOS. This provider is written in Objective-C and can be used with both Objective-C and Swift applications.

The provider officially supports:

• iOS 12+
• tvOS 12+
• macOS 12+

Note: raygun4apple may work with earlier OS versions, however we recommend updating to the versions we build and test for to avoid experiencing any unexpected issues.

Step 1 - Install Raygun4Apple

Using the Swift package manager

Inside of Xcode, navigate to File -> Add Packages and search for this URL string literal: "https://github.com/MindscapeHQ/raygun4apple.git" and install it. You can see more about the package itself here.

Using CocoaPods

To integrate Raygun using CocoaPods, update your Podfile to include:

pod 'raygun4apple'

Once updated you can run pod install from Terminal.

Using GitHub releases

The latest release can be found here. The frameworks are attached to each release as a zipped file. This can be downloaded, unzipped and included in your project directory.

Once included, go to your app's target General settings and add the Raygun4Apple framework to the Frameworks, Libraries, and Embedded Content section. Ensure that the framework is set to Embed & Sign.

Note: The Raygun4Apple provider is developed as a "fat" library, which includes architectures for both simulators and devices. You will need to strip out the simulator architectures (x86_64, i386) before releasing. There is a helpful article on how to do this here.

Step 2 - Configuring the Raygun client

Using the Swift package manager

The configuration step is slightly different if installed via the Swift package manager. Rather than importing the specific header for the target application, simply import raygun4apple.

Here is an example which imports raygun4apple, initializes the provider, and enables Real User Monitoring.

// ContentView.swift

import raygun4apple

// ...

struct ContentView: View {

    init() {
        let raygunClient = RaygunClient.sharedInstance(apiKey: "paste_your_api_key_here")
        raygunClient.enableRealUserMonitoring()
    }
    // ...
}
// ...

In your AppDelegate class file, import the header for your target platform.

Note: For Swift projects you must create an Objective-C bridging header to be able to import the header for your target platform. You can find out how to do this by visiting Apple's documentation for more details.

Using CocoaPods/GitHub releases

For iOS:

#import <raygun4apple/raygun4apple_iOS.h>

For tvOS:

#import <raygun4apple/raygun4apple_tvOS.h>

For macOS:

#import <raygun4apple/raygun4apple_macOS.h>

Initialize the Raygun client by adding the following snippet to your application:didFinishLaunchingWithOptions method:

Objective-C:

RaygunClient *raygunClient = [RaygunClient sharedInstanceWithApiKey:@"paste_your_api_key_here"];
[raygunClient enableRealUserMonitoring];
[raygunClient enableNetworkPerformanceMonitoring]; // Optional

Swift:

let raygunClient = RaygunClient.sharedInstance(apiKey: "paste_your_api_key_here")
raygunClient.enableRealUserMonitoring()

Your app API key is displayed when you create a new application in your Raygun account, or can be viewed in the application settings.

Step 3 - Release

Deploy Raygun into your production environment for best results, or raise a test exception. Once we detect your first error event, the Raygun app will automatically update.

User tracking

By default, each user will be identified with a unique guid and marked as anonymous. The identifier property on the RaygunUserInformation class is what separates one user from another. Be sure to set it with something unique, for example a database id, username or email address. If the user changes, for instance when logging in or out, be sure to update the user information on the shared Raygun client each time. You can assign user information as described below.

The string properties on a User have a maximum length of 255 characters. Users who have fields that exceed this amount will not be processed.

Objective-C:

RaygunUserInformation *userInfo = [[RaygunUserInformation alloc] initWithIdentifier:@"user@raygun.com"
                                                                         withEmail:@"user@raygun.com"
                                                                      withFullName:@"Test User"
                                                                     withFirstName:@"Test"];
RaygunClient.sharedInstance.userInformation = userInfo;

Swift:

let userInformation = RaygunUserInformation(identifier: "user@raygun.com", email: "user@raygun.com", fullName: "Test User", firstName: "Test")
RaygunClient.sharedInstance().userInformation = userInformation