React Native SDK のトラブルシューティング
概要
Datadog React Native RUM で予期せぬ動作が発生した場合、このガイドを使用して問題を迅速に解決してください。問題が解決しない場合は、Datadog サポートにお問い合わせください。
Datadog にデータが送信されていない
SDK をインストールし、アプリをコンパイルしたが、Datadog からデータが受信されない場合、以下の手順で順番に説明します。
構成を確認する
構成のちょっとした手違いによって、データが送信されない場合があります。
ここでは、よくあるチェックポイントをご紹介します。
clientToken と applicationId が正しいことを確認します。sessionSamplingRate を 100 (デフォルト値) 以外に設定していないか確認してください。それ以外の値に設定するとセッションが送信されない可能性があります。- Datadog の構成で
Proxy を設定している場合、それが正しく構成されているか確認します。 - ビューの追跡 (すべてのイベントはビューにアタッチされている必要があります) とイベントの送信を行っていることを確認してください。
React Native で SDK のログを確認する
config.verbosity = SdkVerbosity.DEBUG を設定します。これは @datadog/mobile-react-native から SdkVerbosity をインポートしています。
以下の出力のように、JavaScript コンソールにログが表示されるようになります。
INFO DATADOG: Datadog SDK was initialized
INFO DATADOG: Datadog SDK is tracking interactions
INFO DATADOG: Datadog SDK is tracking XHR resources
INFO DATADOG: Datadog SDK is tracking errors
DEBUG DATADOG: Starting RUM View "Products" #Products-oaZlP_FVwGM5vtPoup_rT
DEBUG DATADOG: Adding RUM Action "RCTView" (TAP)
注: この例では、最初の 4 つのログは SDK が正しく構成されていることを示し、最後の 2 行は送信されたイベントです。
考えられる原因
iOS で、ログや RUM イベントが初期化ログの前に送信されたことを示す DEBUG ログがある場合、これが SDK がイベントを送信しない理由かもしれません。
初期化前にイベントを送ることはできませんし、送ろうとすると SDK がデータを送れない状態になります。
ソリューション
Datadog SDK を起動するために DdSdkReactNative.initialize を使用する場合、トップレベルの index.js ファイルでこの関数を呼び出し、他のイベントが送信される前に SDK が初期化されるようにします。
SDK バージョン 1.2.0 からは、DatadogProvider コンポーネントを使用して SDK を初期化することができます。このコンポーネントには RUM イベントバッファが含まれており、Datadog にデータを送信する前に SDK が初期化されていることを確認することで、この問題の発生を防ぐことができます。
利用するには、Datadog Provider への移行ガイドをご覧ください。
ネイティブログを確認する
ネイティブのログを確認することで、何が問題になっているのか、より多くの情報を得ることができます。
iOS の場合
“DATADOG” でログをフィルターして、任意のエラーを探すことができます。
確かにイベントを送信していれば、以下のようなログが表示されるはずです。
[DATADOG SDK] 🐶 → 10:02:47.398 [DEBUG] ⏳ (rum) Uploading batch...
[DATADOG SDK] 🐶 → 10:02:47.538 [DEBUG] → (rum) accepted, won't be retransmitted: [response code: 202 (accepted), request ID: AAAABBBB-1111-2222-3333-777788883333]
第 1 ログは、何らかのデータを送信中であることを示し、第 2 ログは、データを受信したことを示します。
考えられる原因
以下のようなログが表示された場合、SDK を初期化する前に RUM メソッドを呼び出したことを意味します。
[DATADOG SDK] 🐶 → 10:09:13.621 [WARN] The `Global.rum` was called but no `RUMMonitor` is registered. Configure and register the RUM Monitor globally before invoking the feature:
ソリューション
Datadog SDK を起動するために DdSdkReactNative.initialize を使用する場合、トップレベルの index.js ファイルでこの関数を呼び出し、他のイベントが送信される前に SDK が初期化されるようにします。
SDK バージョン 1.2.0 からは、DatadogProvider コンポーネントを使用して SDK を初期化することができます。このコンポーネントには RUM イベントバッファが含まれており、Datadog にデータを送信する前に SDK が初期化されていることを確認することで、この問題の発生を防ぐことができます。
利用するには、Datadog Provider への移行ガイドをご覧ください。
Android の場合
より快適にデバッグするために、Datadog では pidcat のインストールを推奨しています。
- pidcat は、デバイスログ (
adb logcat で取得) をフィルターして、アプリケーションからのものだけを表示します。 - Python 2 を持っていない M1 ユーザーは この Issue をご参照ください。
ネイティブ SDK から冗長ログを有効にするため、node_modules/@datadog/mobile-react-native/android/src/main/kotlin/com/datadog/reactnative/DdSdk.kt を修正します。
fun initialize(configuration: ReadableMap, promise: Promise) {
// ...
datadog.initialize(appContext, credentials, nativeConfiguration, trackingConsent)
datadog.setVerbosity(Log.VERBOSE) // Add this line
// ...
}
ラップトップにデバッグモードで接続されたスマートフォン (adb devices を実行すると表示されるはずです)、またはエミュレーターからアプリを実行してください。
ラップトップから pidcat my.app.package.name または adb logcat を実行します。
Datadog に言及したエラーがないか確認します。
Pidcat の出力は次のようになります。
この例では、最後のログは、RUM データのバッチが正常に送信されたことを示します。
未定義のシンボル: Swift
以下のエラーメッセージが表示された場合
Undefined symbols for architecture x86_64:
"static Foundation.JSONEncoder.OutputFormatting.withoutEscapingSlashes.getter : Foundation.JSONEncoder.OutputFormatting", referenced from:
static (extension in Datadog):Foundation.JSONEncoder.default() -> Foundation.JSONEncoder in libDatadogSDK.a(JSONEncoder.o)
...
Xcode を開き、プロジェクト (アプリのターゲットではない) の Build Settings を開き、Library Search Paths が以下の設定になっていることを確認してください。
LIBRARY_SEARCH_PATHS = (
"\"$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)\"",
"\"/usr/lib/swift\"",
"\"$(inherited)\"",
);
未定義のシンボル: _RCTModule
_RCTModule が未定義である旨のエラーが表示される場合は、react-native v0.63 のチェンジログにある変更が原因かもしれません。
以下のように変更することで解決します。
// DdSdk.m
// 以下の代わりに
#import <React/RCTBridgeModule.h>
// おそらく:
@import React // または @import React-Core
無限ループのようなエラーメッセージ
React Native プロジェクトがエラーメッセージを次々と表示し、CPU 使用率が著しく上昇する問題に遭遇した場合は、React Native プロジェクトを新規に作成してみてください。
SDK バージョン 2.* での Android ビルドエラー
Unable to make field private final java.lang.String java.io.File.path accessible
もし Android ビルドが以下のようなエラーで失敗する場合:
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':app:processReleaseMainManifest'.
> Unable to make field private final java.lang.String java.io.File.path accessible: module java.base does not "opens java.io" to unnamed module @1bbf7f0e
現在使用している Java 17 は、お使いの React Native バージョンと互換性がありません。Java 11 に切り替えると問題を解決できます。
java.lang.UnsupportedClassVersionError
もし Android ビルドが以下のようなエラーで失敗する場合:
java.lang.UnsupportedClassVersionError: com/datadog/android/lint/DatadogIssueRegistry has been compiled by a more recent version of the Java Runtime (class file version 61.0), this version of the Java Runtime only recognizes class file versions up to 55.0
Java のバージョンが古すぎます。Java 17 に切り替えてください。
Unsupported class file major version 61
もし Android ビルドが以下のようなエラーで失敗する場合:
FAILURE: Build failed with an exception.
* What went wrong:
Could not determine the dependencies of task ':app:lintVitalRelease'.
> Could not resolve all artifacts for configuration ':app:debugRuntimeClasspath'.
> Failed to transform dd-sdk-android-core-2.0.0.aar (com.datadoghq:dd-sdk-android-core:2.0.0) to match attributes {artifactType=android-manifest, org.gradle.category=library, org.gradle.dependency.bundling=external, org.gradle.libraryelements=aar, org.gradle.status=release, org.gradle.usage=java-runtime}.
> Execution failed for JetifyTransform: /Users/me/.gradle/caches/modules-2/files-2.1/com.datadoghq/dd-sdk-android-core/2.0.0/a97f8a1537da1de99a86adf32c307198b477971f/dd-sdk-android-core-2.0.0.aar.
> Failed to transform '/Users/me/.gradle/caches/modules-2/files-2.1/com.datadoghq/dd-sdk-android-core/2.0.0/a97f8a1537da1de99a86adf32c307198b477971f/dd-sdk-android-core-2.0.0.aar' using Jetifier. Reason: IllegalArgumentException, message: Unsupported class file major version 61. (Run with --stacktrace for more details.)
Android Gradle Plugin のバージョンが 5.0 未満です。問題を修正するには、android/gradle.properties ファイルに以下を追加してください:
android.jetifier.ignorelist=dd-sdk-android-core
Duplicate class kotlin.collections.jdk8.*
もし Android ビルドが以下のようなエラーで失敗する場合:
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':app:checkReleaseDuplicateClasses'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable
> Duplicate class kotlin.collections.jdk8.CollectionsJDK8Kt found in modules jetified-kotlin-stdlib-1.8.10 (org.jetbrains.kotlin:kotlin-stdlib:1.8.10) and jetified-kotlin-stdlib-jdk8-1.7.20 (org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.7.20)
Duplicate class kotlin.internal.jdk7.JDK7PlatformImplementations found in modules jetified-kotlin-stdlib-1.8.10 (org.jetbrains.kotlin:kotlin-stdlib:1.8.10) and jetified-kotlin-stdlib-jdk7-1.7.20 (org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.7.20)
Kotlin の依存関係が競合しないよう、プロジェクトで使用する Kotlin バージョンを指定する必要があります。android/build.gradle ファイルで kotlinVersion を指定してください:
buildscript {
ext {
// targetSdkVersion = ...
kotlinVersion = "1.8.21"
}
}
あるいは、android/app/build.gradle ファイルのビルドスクリプトに以下のルールを追加できます:
dependencies {
constraints {
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.8.21") {
because("kotlin-stdlib-jdk7 is now a part of kotlin-stdlib")
}
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.21") {
because("kotlin-stdlib-jdk8 is now a part of kotlin-stdlib")
}
}
}
“Deobfuscation failed” warning
スタックトレースのデオブフスケーションに失敗したときに警告が表示されることがあります。スタックトレースがもともと難読化されていない場合は、この警告は無視してかまいません。そうでない場合は、RUM Debug Symbols ページでアップロードしたソースマップや dSYM、mapping ファイルを確認してください。RUM Debug Symbols を用いた難読化スタックトレースの調査も併せてご覧ください。
その他の参考資料
