CrashReporterモジュール

使用方法

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

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

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

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

• 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. Podfileに次のpodを追加します：

   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")

// 追加したいCollectorsを追加します
config.collectors = [Collectors.AppData, Collectors.Crash] // CrashReporterモジュールをインスタンス化します
config.sendCrashDataOnCrashDetected = true // オプション、trueの場合クラッシュが検出されたときに追加のクラッシュイベントを送信し、そのイベントにのみクラッシュデータを添付します
tealium = Tealium(config: config) { _ in }                               

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

データレイヤー

モジュールが有効な間、各トラッキングコールで送信される変数は以下の通りです：

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

クラッシュの起動

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

テスト

ローカルテストでクラッシュを報告するには、アプリの実行スキームで Debug executable のチェックを外して intentionally crashing the app することで、アプリにデバッガがアタッチされていない状態でクラッシュします。アプリの実行プロセスにデバッガがアタッチされている場合、クラッシュレポーターはクラッシュをキャッチしません。

APIリファレンス

invokeCrash()

CrashReporterモジュールのためのクラッシュを起動します。

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