RUM Mobile SDK のアップグレード

v2 ではアーティファクトがモジュール化されています。以下のアーティファクトを採用してください。

• RUM: com.datadoghq:dd-sdk-android-rum:x.x.x
• Logs: com.datadoghq:dd-sdk-android-logs:x.x.x
• Trace: com.datadoghq:dd-sdk-android-trace:x.x.x
• セッションリプレイ: com.datadoghq:dd-sdk-android-session-replay:x.x.x
• WebView Tracking: com.datadoghq:dd-sdk-android-webview:x.x.x
• OkHttp インスツルメンテーション: com.datadoghq:dd-sdk-android-okhttp:x.x.x

注: NDK Crash Reporting と WebView Tracking を使用する場合は、RUM と Logs にそれぞれイベントを報告するために、RUM と Logs のアーティファクトを追加する必要があります。

com.datadoghq:dd-sdk-android アーティファクトへの参照は、Gradle ビルドスクリプトから削除する必要があります (このアーティファクトはもう存在しないため)。

注: 他のすべてのアーティファクトの Maven 座標は同じままです。

次のようなエラーが発生した場合

A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable
Duplicate class kotlin.collections.jdk8.CollectionsJDK8Kt found in modules kotlin-stdlib-1.8.10 (org.jetbrains.kotlin:kotlin-stdlib:1.8.10) and kotlin-stdlib-jdk8-1.7.20 (org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.7.20)

ビルドスクリプトに以下のルールを追加してください (詳細は関連する [Stack Overflow 問題][2]を参照してください)。

dependencies {
    constraints {
        implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.8.10") {
            because("kotlin-stdlib-jdk7 is now a part of kotlin-stdlib")
        }
        implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.10") {
            because("kotlin-stdlib-jdk8 is now a part of kotlin-stdlib")
        }
    }
}

SDK のセットアップ方法の例については、[Android サンプルアプリケーション][3]をご覧ください。

v2 ではライブラリがモジュール化されています。以下のライブラリを採用してください。

• DatadogCore
• DatadogLogs
• DatadogTrace
• DatadogSessionReplay
• DatadogRUM
• DatadogWebViewTracking

これらは既存の DatadogCrashReporting と DatadogObjc に追加されます。

let package = Package(
  ...
  dependencies: [
      .package(url: "https://github.com/DataDog/dd-sdk-ios", from: "2.0.0")
  ],
  targets: [
      .target(
          ...
          dependencies: [
              .product(name: "DatadogCore", package: "dd-sdk-ios"),
              .product(name: "DatadogLogs", package: "dd-sdk-ios"),
              .product(name: "DatadogTrace", package: "dd-sdk-ios"),
              .product(name: "DatadogSessionReplay", package: "dd-sdk-ios"),
              .product(name: "DatadogRUM", package: "dd-sdk-ios"),
              .product(name: "DatadogCrashReporting", package: "dd-sdk-ios"),
              .product(name: "DatadogWebViewTracking", package: "dd-sdk-ios"),
          ]
      ),
  ]
)

pod 'DatadogCore'
pod 'DatadogLogs'
pod 'DatadogTrace'
pod 'DatadogSessionReplay'
pod 'DatadogRUM'
pod 'DatadogCrashReporting'
pod 'DatadogWebViewTracking'
pod 'DatadogObjc'

github "DataDog/dd-sdk-ios"

DatadogInternal.xcframework
DatadogCore.xcframework

DatadogLogs.xcframework
DatadogTrace.xcframework
DatadogSessionReplay.xcframework
DatadogRUM.xcframework
DatadogCrashReporting.xcframework + CrashReporter.xcframework
DatadogWebViewTracking.xcframework
DatadogObjc.xcframework

注: Crash Reporting と WebView Tracking を使用している場合は、RUM と Logs にそれぞれイベントを報告するために、RUM と Logs のモジュールを追加する必要があります。

異なる製品を独立したモジュールに抽出することで、SDK 構成はモジュールごとに整理されます。

com.datadog.android.core.configuration.Configuration.Builder クラスに以下の変更がありました。

• クライアントトークン、環境変数名、バリアント名 (デフォルト値は空の文字列)、サービス名 (デフォルト値はマニフェストから取得したアプリケーション ID) はコンストラクタで指定する必要があります。
• com.datadog.android.core.configuration.Credentials クラスは削除されました。
• logsEnabled、tracesEnabled、rumEnabled はコンストラクタから削除され、個別の製品構成が推奨されます (下記参照)。
• crashReportsEnabled コンストラクタ引数が削除されました。JVM クラッシュレポートの有効/無効は Configuration.Builder.setCrashReportsEnabled メソッドで設定できます。デフォルトでは、JVM クラッシュレポートは有効になっています。
• RUM、Logs、および Trace 製品構成メソッドが Configuration.Builder から削除され、個々の製品構成が推奨されます (下記参照)。

Datadog.initialize メソッドの引数リストから Credentials クラスが削除されました。

com.datadog.android.plugin パッケージと関連するすべてのクラス/メソッドが削除されました。

Logs

Logs 製品に関連するすべてのクラスは com.datadog.android.log パッケージ内に厳密に収められています。

Logs 製品を使用するには、以下のアーティファクトをインポートします。

implementation("com.datadoghq:dd-sdk-android-logs:x.x.x")

次のスニペットで Logs 製品を有効にすることができます。

val logsConfig = LogsConfiguration.Builder()
    ...
    .build()

Logs.enable(logsConfig)

val logger = Logger.Builder()
    ...
    .build()

API の変更:

Trace

Trace 製品に関連するすべてのクラスは com.datadog.android.trace パッケージ内に厳密に収められています (これは、以前の com.datadog.android.tracing にあったすべてのクラスが移動したことを意味します)。

Trace 製品を使用するには、以下のアーティファクトをインポートします。

implementation("com.datadoghq:dd-sdk-android-trace:x.x.x")

次のスニペットで Trace 製品を有効にすることができます。

val traceConfig = TraceConfiguration.Builder()
    ...
    .build()

Trace.enable(traceConfig)

val tracer = AndroidTracer.Builder()
    ...
    .build()

GlobalTracer.registerIfAbsent(tracer)

API の変更:

RUM

RUM 製品に関連するすべてのクラスは com.datadog.android.rum パッケージ内に厳密に収められています。

RUM 製品を使用するには、以下のアーティファクトをインポートします。

implementation("com.datadoghq:dd-sdk-android-rum:x.x.x")

次のスニペットで RUM 製品を有効にすることができます。

val rumConfig = RumConfiguration.Builder(rumApplicationId)
    ...
    .build()

Rum.enable(rumConfig)

API の変更:

NDK Crash Reporting

アーティファクト名は以前のままです: com.datadoghq:dd-sdk-android-ndk:x.x.x

次のスニペットで NDK Crash Reporting を有効にすることができます。

NdkCrashReports.enable()

この構成は com.datadog.android.core.configuration.Configuration.Builder.addPlugin コールを置き換えます。

注: RUM と Logs でそれぞれ NDK クラッシュレポートを受信するには、RUM と Logs 製品を有効にする必要があります。

WebView Tracking

アーティファクト名は以前のままです: com.datadoghq:dd-sdk-android-webview:x.x.x

次のスニペットで WebView Tracking を有効にすることができます。

WebViewTracking.enable(webView, allowedHosts)

注: RUM と Logs でそれぞれ WebView からのイベントを受信するには、RUM と Logs 製品を有効にする必要があります。

API の変更:

OkHttp Tracking

OkHttp Tracking を使用するには、以下のアーティファクトをインポートします。

implementation("com.datadoghq:dd-sdk-android-okhttp:x.x.x")

OkHttp インスツルメンテーションは、OkHttp クライアントの後に Datadog SDK を初期化することをサポートしているため、Datadog SDK の前に com.datadog.android.okhttp.DatadogEventListener、com.datadog.android.okhttp.DatadogInterceptor、com.datadog.android.okhttp.trace.TracingInterceptorを作成することができます。OkHttp インスツルメンテーションは、Datadog SDK が初期化されると Datadog へのイベント報告を開始します。

com.datadog.android.okhttp.DatadogInterceptor と com.datadog.android.okhttp.trace.TracingInterceptor により、リモート構成システムとのインテグレーションを通じて、サンプリングを動的に制御することができます。

サンプリングを動的に調整するには、com.datadog.android.okhttp.DatadogInterceptor/com.datadog.android.okhttp.trace.TracingInterceptor コンストラクタに com.datadog.android.core.sampling.Sampler インターフェイスの独自の実装を指定します。これは各リクエストに対してクエリされ、サンプリングの決定を行います。

dd-sdk-android-ktx モジュールの削除

使用する Datadog SDK ライブラリの粒度を改善するために、dd-sdk-android-ktx モジュールは削除されました。RUM と Trace 機能の両方の拡張機能メソッドを提供するために、他のモジュール間にコードが分散されます。

セッションリプレイ

モバイルセッションリプレイのセットアップ方法については、モバイルセッションリプレイのセットアップと構成を参照してください。

異なる製品を独立したモジュールに抽出することで、SDK 構成はモジュールごとに整理されます。

製品を有効にする前に、SDK を初期化する必要があります。

SDK 初期化の Builder パターンは削除され、構造定義が推奨されます。次の例は 1.x の初期化が 2.0 でどのように変換されるかを示しています。

V1 初期化

import Datadog

Datadog.initialize(
    appContext: .init(),
    trackingConsent: .granted,
    configuration: Datadog.Configuration
        .builderUsing(
            clientToken: "<client token>",
            environment: "<environment>"
        )
        .set(serviceName: "<service name>")
        .build()

V2 初期化

import DatadogCore

Datadog.initialize(
    with: Datadog.Configuration(
        clientToken: "<client token>",
        env: "<environment>",
        service: "<service name>"
    ), 
    trackingConsent: .granted
)

API の変更:

Logs

Logs に関連するすべてのクラスは DatadogLogs モジュール内に厳密に収められています。まず、製品を有効にする必要があります。

import DatadogLogs

Logs.enable(with: Logs.Configuration(...))

次に、ロガーインスタンスを作成できます。

import DatadogLogs

let logger = Logger.create(
    with: Logger.Configuration(name: "<logger name>")
)

API の変更:

Trace

Trace に関連するすべてのクラスは DatadogTrace モジュール内に厳密に収められています。まず、製品を有効にする必要があります。

import DatadogTrace

Trace.enable(
    with: Trace.Configuration(...)
)

次に、共有された Tracer インスタンスにアクセスできます。

import DatadogTrace

let tracer = Tracer.shared()

API の変更:

RUM

RUM に関連するすべてのクラスは DatadogRUM モジュール内に厳密に収められています。まず、製品を有効にする必要があります。

import DatadogRUM

RUM.enable(
    with: RUM.Configuration(applicationID: "<RUM Application ID>")
)

次に、共有された RUM モニターインスタンスにアクセスできます。

import DatadogRUM

let monitor = RUMMonitor.shared()

API の変更:

Crash Reporting

Crash Reporting を有効にするには、RUM と Logs を有効にして、これらの製品それぞれに報告するようにしてください。

import DatadogCrashReporting

CrashReporting.enable()

WebView Tracking

WebViewTracking を有効にするには、RUM と Logs も有効にして、これらの製品それぞれに報告するようにしてください。

import WebKit
import DatadogWebViewTracking

let webView = WKWebView(...)
WebViewTracking.enable(webView: webView)

セッションリプレイ

モバイルセッションリプレイのセットアップ方法については、モバイルセッションリプレイのセットアップと構成を参照してください。