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.

Using the Swift Package Manager

To integrate Raygun into an SPM managed application, update your Package.swift file to include raygun4apple as a dependency.

Here is an example of a macOS CLI application which uses raygun4apple as a dependency:

import PackageDescription

let package = Package(
    name: "macos-cli",
    dependencies: [
        //Note - the version must be atleast 2.0.0 as this is earliest release of this package through SPM.
        .package(url: "https://github.com/MindscapeHQ/raygun4apple.git", from: "2.0.0"),
    ],
    targets: [
        .executableTarget(
            name: "macos-cli",
            dependencies: ["raygun4apple"])
    ]
)

Configuring the Raygun client

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 sends a test exception.

import raygun4apple

let raygunClient = RaygunClient.sharedInstance(apiKey: "YOUR_API_KEY_HERE")
raygunClient.enableCrashReporting()
raygunClient.send(exception: NSException.init(name: NSExceptionName.illegalSelectorException, reason: "This is a macOS error!"))

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 you 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.

Configuring the Raygun client

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

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:@"YOUR_APP_API_KEY"];
[raygunClient enableCrashReporting];

Swift:

let raygunClient = RaygunClient.sharedInstance(apiKey: "YOUR_APP_API_KEY")
raygunClient.enableCrashReporting()

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

User tracking

This provider supports tracking the unique users who encounter errors and crashes in your mobile apps.

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.

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.

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.

Objective-C:

RaygunUserInformation *userInfo = nil;
userInfo = [[RaygunUserInformation alloc] initWithIdentifier:@"ronald@raygun.com"
                                                  withEmail:@"ronald@raygun.com"
                                               withFullName:@"Ronald Raygun"
                                              withFirstName:@"Ronald"];
RaygunClient.sharedInstance.userInformation = userInfo;

Swift:

let userInformation = RaygunUserInformation(identifier: "ronald@raygun.com", email: "ronald@raygun.com", fullName: "Ronald Raygun", firstName: "Ronald")
RaygunClient.sharedInstance().userInformation = userInformation