CrashReporter モジュール

使用法

CrashReporter モジュールは、アプリのクラッシュを自動的に追跡します。モジュールが有効化され、関連するフレームワークがインストールされると、アプリでクラッシュが発生した後にクラッシュデータが追跡イベントに追加されます。

オプションとして、sendCrashDataOnCrashDetected 構成フラグを true に構成することで、SDK を追加の crash イベントを送信するように構成することができます。これを行うと、クラッシュデータはこの特定のイベントにのみ追加されます。

このフレームワークの使用は、アプリのクラッシュに関する重要な情報を得るために推奨されます。

以下のプラットフォームがサポートされています：

• iOS
• tvOS
• macOS

インストール

Swift Package Manager または CocoaPods で Crash モジュールをインストールします。

Swift Package Manager（推奨）

バージョン 1.9.0+ でサポートされている Swift Package Manager は、Tealium Swift ライブラリをインストールする最も簡単で推奨される方法です：

1. Xcode プロジェクトで、File > Add Package Dependencies を選択します。
2. リポジトリの URL を入力します：https://github.com/tealium/tealium-swift-crash-reporter
3. バージョンルールを構成します。通常、"Up to next major" が推奨されます。現在の Tealium Swift ライブラリのバージョンがリストに表示されない場合は、Swift パッケージキャッシュをリセットします。
4. TealiumCrashModule を選択し、Xcode プロジェクトの各アプリターゲットに追加します。これは Frameworks and Libraries の下にあります。
5. これらの指示に従って、tealium-swift ライブラリから他のモジュールを追加します。

CocoaPods

CocoaPods を使用して CrashReporter モジュールをインストールするには：

1. 以下の pod を Podfile に追加します：

   pod 'TealiumCrashModule'
   

   すでに Podfile には以下の行が含まれています：

   pod 'tealium-swift'
   

2. 以下のコマンドを実行します：

   pod install
   

Carthage

Carthage を使用して CrashReporter モジュールをインストールするには：

1. 以下を Cartfile に追加します：

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

2. Xcode のアプリターゲットの General 構成ページに移動します。

3. 以下のフレームワークを Embedded Binaries セクションに追加します：

   TealiumCrashModule.framework
   CrashReporter.framework
   

iOS 用の Carthage インストールについてはこちらを参照してください。

構成

CrashReporter モジュールをインスタンス化するためには、SDK を初期化する際に TealiumConfig オブジェクトでそれを指定する必要があります：

import TealiumCore
import TealiumCrashModule

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

// add desired Collectors
config.collectors = [Collectors.AppData, Collectors.Crash] // Instantiates the CrashReporter module
config.sendCrashDataOnCrashDetected = true // optional, If true it sends an extra crash event when a crash is detected and only attaches crash data to that event
tealium = Tealium(config: config) { _ in }                               

Collectors のドキュメンテーションを確認し、必要なコレクターを正しく指定する方法を理解してください。

データレイヤー

モジュールが有効化されている間、以下の変数が各トラッキングコールとともに送信されます：

• これらの変数は、以前のリリースとの後方互換性のために複製されています

クラッシュの発生

TealiumCrashReporteriOS.framework がプロジェクトに追加された後、追加の初期化ステップは必要ありません。クラッシュモジュールが有効化され、Tealium SDK が初期化されている限り、アプリでクラッシュが発生すると、クラッシュデータは自動的にトラッキングコールの一部となります。

テスト

ローカルテストでクラッシュを報告するためには、アプリを意図的にクラッシュさせる前にアプリの実行スキームで Debug executable のチェックを外し、アプリにデバッガがアタッチされていないようにします。アプリの実行プロセスにデバッガがアタッチされていると、クラッシュレポーターはクラッシュをキャッチしません。

API リファレンス

invokeCrash()

CrashReporter モジュールのクラッシュを発生させます。

TealiumCrashReporter.invokeCrash(name: name, reason: reason)