CrashReporter Module

Usage

The CrashReporter module automatically tracks crashes in your app. Once the module is enabled and the accompanying frameworks are installed, a crash event is triggered if a crash occurs in your app.

Usage of this framework is recommended to get vital information regarding your app’s crashes.

The following platforms are supported:

• iOS
• tvOS
• macOS

Install

Install the Crash module with Swift Package Manager or CocoaPods.

Swift Package Manager (Recommended)

Supported in version 1.9.0+, the Swift Package Manager is the recommended and simplest way to install the Tealium Swift library:

1. In your Xcode project, select File > Swift Packages > Add Package Dependency
2. Enter the repository URL: https://github.com/tealium/tealium-swift-crash-reporter
3. Configure the version rules. Typically, "Up to next major" is recommended. If the current Tealium Swift library version does not appears in the list, then reset your Swift package cache.
4. Select the `TealiumCrashModule and add it each of your app targets in your Xcode project, under Frameworks > Libraries & Embedded Content
5. Follow these instructions to add other modules from the tealium-swift library.

CocoaPods

To install the CrashReporter module with CocoaPods:

1. Add the following pod to your Podfile:

   pod 'TealiumCrashModule'
   

   Your Podfile already contains the following line:

   pod 'tealium-swift'
   

2. Run the following command:

   pod install
   

Carthage

To install the CrashReporter module with Carthage:

1. Add the following to your Cartfile:

   github "tealium/tealium-swift-crash-reporter"
   

2. Go to the app target’s General configuration page in Xcode.

3. Add the following frameworks to the Embedded Binaries section:

   TealiumCrashModule.framework
   CrashReporter.framework
   

Learn more about Carthage installation for iOS.

Configure

In order to instantiate the CrashReporter module, you must specify it in your TealiumConfig object when initializing the SDK:

import TealiumCore
import TealiumCrashModule

let config = TealiumConfig(account: "ACCOUNT",
                               profile: "PROFILE",
                               environment: "ENVIRONMENT",
                               datasource: "DATASOURCE")

// add desired Collectors - no need to include if want compiled Collectors
config.collectors = [Collectors.AppData,
					 Collectors.Crash,] // Instantiates the CrashReporter module
tealium = Tealium(config: config) { _ in }                               

Review the Collectors documentation to understand how to correctly specify the collectors you require.

Data Layer

The following variables are transmitted with each tracking call while the module is enabled:

• These variables are duplicated for backward-compatibility with previous releases

Invoke a Crash

Once TealiumCrashReporteriOS.framework is added to your project, no additional initialization steps are needed. As long as the crash module is enabled and the Tealium SDK is initialized, when a crash is exhibited in your app, crash data automatically becomes part of the tracking call.

API Reference

invokeCrash()

Invokes a crash for the CrashReporter module.

TealiumCrashReporter.invokeCrash(name, reason)