Documentation

Check out our guides and API reference documentation on how to use Rollbar to monitor, debug, and triage errors.

Guides & SDKs    API Reference

Apple

Rollbar SDK for any Apple *OS (macOS, iOS, tvOS, watchOS, ...).
Written in Objective-C. Works with Swift.

What is Rollbar-Apple SDK?

Objective-C & Swift SDK for remote crash, exception, error reporting, and logging with
Rollbar.

It works on all Apple *OS platforms (macOS, iOS, tvOS, watchOS, etc).

It is the preferred SDK for sending log payloads to Rollbar.

How is Rollbar-Apple SDK different from Rollbar-iOS SDK?

Look at Rollbar-Apple SDK as the next major reincarnation of Rollbar-iOS SDK.
It is v2 of Rollbar-iOS SDK under a new name that better describes its purpose.

Rollbar-iOS will be available for a while to allow our customers to make a move to Rollbar-Apple SDK when it most convenient to them.

All the new feature development will be happening here within Rollbar-Apple SDK.

Where can I get the SDK from?

Rollbar-Apple SDK is an open-source project available on GitHub.
Its releases are published on GitHub as well.
The SDK can also be integrated into your codebase from the following package distribution systems:

  • Swift Package Manager (also known as SwiftPM or SPM)
  • Cocoapods
  • Carthage

🚧

Pay Attention

Depending on the specific package management system, the SDK is available either as the whole (under Rollbar-Apple name) or on a per-module basis (for example, RollbarCommon, RollbarNotifier, RollbarDeploys, etc).

Some package distribution systems also host packages associated with the older incarnation of this SDK, called Rollbar-iOS, that used to be published under Rollbar package name and versioned at either v0.n.n or v1.n.n.

All the Rollbar-Apple SDK releases (and packages) versioned starting from v2 (since, as we already explained above, Rollbar-Apple is the v2 of Rollbar-iOS SDK renamed into Rollbar-Apple).

SDK Modules/Packages Overview

RollbarNotifier is the package that implements the RollbarLogger (i.e. Notifier) - that is the thing that supports a lot of configurational options and allows to capture, package, and forward (to the preconfigured Rollbar Project on rollbar.com) exceptions, errors, log messages, telemetry, and custom data.

We offer a couple of optional crash reporting alternatives - one based on KSCrash and another one based on PLCrashReporter. Each package (RollbarKSCrash or RollbarPLCrashReporter) implements its own crash report collector adapter to a corresponding third-party crash reporter.
A collector is optional and can be supplied into a notifier (RollbarLogger) initializer along with the required RollbarConfig instance.

RollbarSwift implements components useful in cases when the SDK is used by a client code written in Swift. For example, any call chain made from Swift that eventually resolves into an Objective-C code being invoked can potentially produce an NSException that Swift can ot handle natively. So, the module provides utility classes and components that are helping to either handle or process such scenarios.

RollbarDeploys is the package that should be used, for example by your CI Release pipeline, to track/manage your application releases/deployments so they are reported to the Rollbar Project and Rollbar would correlate the incoming payloads with specific deployment instance.

RollbarCommon is just a shared package with types used by any of the other packages as well as some potentially useful public utility classes that you may find useful.

Installation

Here are a few alternatives for installing the SDK into your software projects:

Via GitHub

Here are a few options:

  • you can download or clone the SDK source code directly from the GitHub repo;
  • you can download a source code snapshot of a specific release from the repo Release page;
  • you can integrate the the GitHub repo as a git submodule of your project git repository.

For example, in Xcode, by pointing your project's build target SPM settings to https://github.com/rollbar/rollbar-apple.git repository and specifying the desired release version, or branch, or commit.

In your Cartfile, specify:

github "rollbar/rollbar-apple" ~> n.n.n

where n.n.n is the desired pod version of the SDK to use.

The SDK is configured for Cocoapods distribution on a pod-per-module basis, so you will have to separately specify each module pod dependency as needed. For example:

pod "RollbarNotifier", "~> n.n.n"
pod "RollbarDeploys", "~> n.n.n"

where n.n.n is the desired pod version of the SDK to use. As the general rule, for multiple modules try using the same version.

You do not have to worry about explicitly including other internal dependencies of the modules, like RollbarCommon module pod. The SDK modules podspecs already specify these as needed.

Using SDK in Your Code

Import Necessary SDK Modules

Before using any of the types provided by the SDK modules, you need to make sure you import the modules you need. For example:

@import RollbarNotifier;
@import RollbarKSCrash;          // optional
@import RollbarPLCrashReporter;  // optional alternative to RollbarKSCrash
import RollbarNotifier
import RollbarKSCrash          // optional
import RollbarPLCrashReporter  // optional alternative to RollbarKSCrash

Define the Shared Notifier's Configuration Instance

When setting up a notifier configuration you must at least specify your Rollbar Project's access token:

RollbarConfig *config = [RollbarConfig new];
config.destination.accessToken = @"YOUR_PROJECT_ACCESSS_TOKEN";
config.destination.environment = @"YOUR_ENVIRONMENT_ID";
let config = RollbarConfig()
config.destination.accessToken = "YOUR_PROJECT_ACCESSS_TOKEN"
config.destination.environment = "ENVIRONMENT"

Optionally, Define A Crash Report Collector Instance

id<RollbarCrashCollector> crashCollector =
  [[RollbarPLCrashCollector alloc] init];
  //OR [[RollbarKSCrashCollector alloc] init];
  //OR nil;
let crashCollector = RollbarPLCrashCollector()
//OR let crashCollector = RollbarKSCrashCollector()

Initialize the Shared Notifier

[Rollbar initWithConfiguration:config];
//OR [Rollbar initWithConfiguration:config crashCollector:crashCollector];
Rollbar.initWithConfiguration(config)
//OR Rollbar.initWithConfiguration(config, crashCollector: crashCollector)

Start Logging using the Shared Notifier

[Rollbar infoMessage:@"See this message on your Rollbar Project Dashboard..."];
Rollbar.infoMessage("See this message on your Rollbar Project Dashboard...")

There are other dedicated method overloads for logging NSExceptions, NSErrorrs with different levels of log severity.

Updated 27 days ago


Apple


Rollbar SDK for any Apple *OS (macOS, iOS, tvOS, watchOS, ...).
Written in Objective-C. Works with Swift.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.