La migración de v1 a v2 representa una migración de un SDK monolito a una arquitectura modular. RUM, trazas, Logs, Session Replay, etc., cada uno tiene módulos individuales, lo que te permite integrar solo lo que se necesita en tu aplicación.

SDK v2 ofrece un diseño de API unificado y una alineación de nombres entre el SDK de iOS, el SDK de Android y otros productos de Datadog.

SDK v2 permite el uso de Mobile Session Replay en aplicaciones Android e iOS.

La migración de v1 a v2 representa una migración de un SDK monolito a una arquitectura modular. RUM, trazas, logs, Session Replay, etc., cada uno tiene módulos individuales, lo que te permite integrar solo lo que se necesita en tu aplicación.

SDK v2 ofrece un diseño de API unificado y una alineación de nombres entre el SDK de iOS, el SDK de Android y otros productos de Datadog.

SDK v2 permite el uso de Mobile Session Replay en aplicaciones Android e iOS.

La migración de v1 a v2 viene con un rendimiento mejorado.

La migración de v1 a v2 viene con un rendimiento mejorado y funciones adicionales suministradas por los SDK nativos de v2.

Los artefactos se modularizan en la v2. Adopta los siguientes artefactos:

• RUM: com.datadoghq:dd-sdk-android-rum:x.x.x
• Logs: com.datadoghq:dd-sdk-android-logs:x.x.x
• Traza: com.datadoghq:dd-sdk-android-trace:x.x.x
• Session Replay: com.datadoghq:dd-sdk-android-session-replay:x.x.x
• WebView Tracking: com.datadoghq:dd-sdk-android-webview:x.x.x
• Instrumentación de OkHttp: com.datadoghq:dd-sdk-android-okhttp:x.x.x

Nota: Si utilizas NDK Crash Reporting y WebView Tracking, debes añadir artefactos RUM y logs para informar de eventos a RUM y logs respectivamente.

La referencia al artefacto com.datadoghq:dd-sdk-android debería ser eliminada de tu script de compilación Gradle, ya que este artefacto ya no existe.

Nota: Las coordenadas Maven de todos los demás artefactos siguen siendo las mismas.

Si te encuentras con un error como el siguiente:

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)

Añade las siguientes reglas a tu script de compilación (más detalles en el Problema de sobrecarca del stack):

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

Consulta la aplicación de muestra de Android para ver un ejemplo de cómo configurar el SDK.

Las bibliotecas se modularizan en la v2. Adopta las siguientes bibliotecas:

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

Estas se suman a las ya existentes DatadogCrashReporting y 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

Nota: Cuando utilices Crash Reporting y WebView Tracking, debes añadir los módulos RUM y logs para informar de eventos a RUM y logs respectivamente.

Actualiza @datadog/mobile-react-native en tu package.json:

"@datadog/mobile-react-native": "2.0.0"

Actualiza tus pods de iOS:

(cd ios && bundle exec pod update)

Si utilizas una versión de React Native estrictamente superior a 0.67, utiliza Java versión 17. Si utilizas una versión de React Native igual o inferior a 0.67, utiliza Java versión 11. Para comprobar tu versión de Java, ejecuta lo siguiente en un terminal:

java --version

Para React Native < 0.73

En tu archivo android/build.gradle, especifica kotlinVersion para evitar conflictos entre las dependencias de Kotlin:

buildscript {
    ext {
        // targetSdkVersion = ...
        kotlinVersion = "1.8.21"
    }
}

Para React Native < 0.68

En tu archivo android/build.gradle, especifica kotlinVersion para evitar conflictos entre las dependencias de Kotlin:

buildscript {
    ext {
        // targetSdkVersion = ...
        kotlinVersion = "1.8.21"
    }
}

Si utilizas una versión de com.android.tools.build:gradle inferior a 5.0 en tu android/build.gradle, añádela en tu archivo android/gradle.properties:

android.jetifier.ignorelist=dd-sdk-android-core

Solucionar problemas

La compilación de Android falla con Unable to make field private final java.lang.String java.io.File.path accessible

Si tu compilación de Android falla con un error como:

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

Estás usando Java 17, que no es compatible con tu versión de React Native. Cambia a Java 11 para resolver el problema.

La compilación de Android falla con Unsupported class file major version 61

Si tu compilación de Android falla con un error como:

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

Utilizas una versión de Android Gradle Plugin inferior a 5.0. Para solucionar el problema, añade en tu archivo android/gradle.properties:

android.jetifier.ignorelist=dd-sdk-android-core

La compilación de Android falla con Duplicate class kotlin.collections.jdk8.*

Si tu compilación de Android falla con un error como:

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)

Necesitas establecer una versión de Kotlin para tu proyecto para evitar conflictos entre las dependencias de Kotlin. En tu archivo android/build.gradle, especifica la versión kotlinVersion:

buildscript {
    ext {
        // targetSdkVersion = ...
        kotlinVersion = "1.8.21"
    }
}

Alternativamente, puedes añadir las siguientes reglas a tu script de compilación en tu archivo android/app/build.gradle:

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

Actualiza datadog_flutter_plugin en tu pubspec.yaml:

dependencies:
  'datadog_flutter_plugin: ^2.0.0

Solucionar problemas

Duplicar interfaz (iOS)

Si aparece este error al compilar iOS después de actualizar a datadog_flutter_plugin v2.0:

Semantic Issue (Xcode): Duplicate interface definition for class 'DatadogSdkPlugin'
/Users/exampleuser/Projects/test_app/build/ios/Debug-iphonesimulator/datadog_flutter_plugin/datadog_flutter_plugin.framework/Headers/DatadogSdkPlugin.h:6:0

Prueba realizar flutter clean && flutter pub get y volver a compilar. Esto suele resolver el problema.

Clases duplicadas (Android)

Si aparece este error al compilar Android tras la actualización a datadog_flutter_plugin v2.0:

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:checkDebugDuplicateClasses'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable

Asegúrate de que has actualizado tu versión de Kotlin al menos a la 1.8 en tu archivo build.gradle.

Con la extracción de productos diferentes en módulos independientes, la configuración del SDK está organizada por módulo.

com.datadog.android.core.configuration.Configuration.Builder tiene los siguientes cambios:

• El token del cliente, el nombre del entorno, el nombre de la variante (el valor por defecto es una cadena vacía) y el nombre de servicio (el valor por defecto es el ID de la aplicación tomado del manifiesto) deben proporcionarse en el constructor.
• Se elimina la clase com.datadog.android.core.configuration.Credentials.
• logsEnabled, tracesEnabled y rumEnabled se eliminan del constructor en favor de la configuración del producto individual (consulta más adelante).
• Se elimina el argumento del constructor crashReportsEnabled. Puedes activar o desactivar el informe de fallos de JVM con el método Configuration.Builder.setCrashReportsEnabled. Por defecto, el informe de fallos de JVM está activado.
• Los métodos de configuración de productos de RUM, logs y trazas se eliminan de Configuration.Builder en favor de la configuración de productos individuales (consulta más abajo).

El método Datadog.initialize tiene la clase Credentials eliminada de la lista de los argumentos.

Se elimina el paquete com.datadog.android.plugin y todas las clases/métodos relacionados.

Logs

Todas las clases relacionadas con el producto de logs están estrictamente contenidas en el paquete com.datadog.android.log.

Para utilizar el producto de logs, importa el siguiente artefacto:

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

Puedes activar el producto de logs con el siguiente fragmento:

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

Logs.enable(logsConfig)

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

Cambios en la API:

Traza

Todas las clases relacionadas con el producto de traza están estrictamente contenidas en el paquete com.datadog.android.trace (esto significa que todas las clases que antes residían en com.datadog.android.tracing se han desplazado).

Para utilizar el producto de traza, importa el siguiente artefacto:

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

Puedes activar el producto de traza con el siguiente fragmento:

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

Trace.enable(traceConfig)

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

GlobalTracer.registerIfAbsent(tracer)

Cambios en la API:

RUM

Todas las clases relacionadas con el producto RUM están estrictamente contenidas en el paquete com.datadog.android.rum.

Para utilizar el producto RUM, importa el siguiente artefacto:

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

Puedes activar el producto RUM con el siguiente fragmento:

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

Rum.enable(rumConfig)

Cambios en la API:

NDK Crash Reporting

El nombre del artefacto sigue siendo el mismo que antes: com.datadoghq:dd-sdk-android-ndk:x.x.x.

Puedes activar NDK Crash Reporting con el siguiente fragmento:

NdkCrashReports.enable()

Esta configuración sustituye a la llamada com.datadog.android.core.configuration.Configuration.Builder.addPlugin.

Nota: Debes tener habilitados los productos RUM y logs para recibir informes de fallos del NDK en RUM y logs respectivamente.

WebView Tracking

El nombre del artefacto sigue siendo el mismo que antes: com.datadoghq:dd-sdk-android-webview:x.x.x

Puedes activar WebView Tracking con el siguiente fragmento de código:

WebViewTracking.enable(webView, allowedHosts)

Nota: Debes tener habilitados los productos RUM y logs para recibir eventos procedentes de WebView en RUM y logs respectivamente.

Cambios en la API:

OkHttp Tracking

Para utilizar OkHttp Tracking, importa el siguiente artefacto:

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

La instrumentación de OkHttp admite la inicialización del SDK de Datadog después del cliente OkHttp, permitiendo crear com.datadog.android.okhttp.DatadogEventListener, com.datadog.android.okhttp.DatadogInterceptor y com.datadog.android.okhttp.trace.TracingInterceptor antes que el SDK de Datadog. La instrumentación de OkHttp comienza a informar eventos a Datadog una vez que el SDK de Datadog es inicializado.

Tanto com.datadog.android.okhttp.DatadogInterceptor como com.datadog.android.okhttp.trace.TracingInterceptor permiten controlar el muestreo de forma dinámica a través de la integración con un sistema de configuración remoto.

Para ajustar dinámicamente el muestreo, proporciona tu propia implementación de la interfaz com.datadog.android.core.sampling.Sampler en el constructor com.datadog.android.okhttp.DatadogInterceptor/com.datadog.android.okhttp.trace.TracingInterceptor. Se consulta para cada solicitud para tomar la decisión de muestreo.

Extracción del módulo dd-sdk-android-ktx

Para mejorar el nivel de detalle de las bibliotecas del SDK de Datadog utilizadas, se elimina el módulo dd-sdk-android-ktx. El código se distribuye entre los demás módulos para proporcionar métodos de extensión tanto para las funciones RUM como para trazas.

Session Replay

Para obtener instrucciones sobre la configuración de Mobile Session Replay, consulta Configuración de Mobile Session Replay.

Con la extracción de diferentes productos en módulos independientes, la configuración del SDK se organiza por módulos.

El SDK debe inicializarse antes de habilitar cualquier producto.

El patrón Builder (compilador) de la inicialización del SDK se ha eliminado en favor de las definiciones de estructura. El siguiente ejemplo muestra cómo una inicialización 1.x se traduciría en 2.0.

Inicialización V1

import Datadog

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

Inicialización V2

import DatadogCore

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

Cambios en la API:

Logs

Todas las clases relacionadas con logs se encuentran estrictamente en el módulo DatadogLogs. Primero tienes que habilitar el producto:

import DatadogLogs

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

A continuación, puedes crear una instancia del registrador:

import DatadogLogs

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

Cambios en la API:

Traza

Todas las clases relacionadas con trazas se encuentran estrictamente en el módulo DatadogTrace. Primero tienes que habilitar el producto:

import DatadogTrace

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

A continuación, puedes acceder a la instancia compartida del rastreador:

import DatadogTrace

let tracer = Tracer.shared()

Cambios en la API:

RUM

Todas las clases relacionadas con RUM se encuentran estrictamente en el módulo DatadogRUM. Primero debes habilitar el producto:

import DatadogRUM

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

A continuación, podrás acceder a la instancia de monitor RUM compartida:

import DatadogRUM

let monitor = RUMMonitor.shared()

Cambios en la API:

Crash Reporting

Para habilitar Crash Reporting, asegúrate de habilitar RUM y logs para informar a esos productos respectivamente.

import DatadogCrashReporting

CrashReporting.enable()

WebView Tracking

Para habilitar WebViewTracking, asegúrate de habilitar también RUM y logs para informar a esos productos respectivamente.

import WebKit
import DatadogWebViewTracking

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

Session Replay

Para obtener instrucciones sobre la configuración de Mobile Session Replay, consulta Configuración de Mobile Session Replay.

No es necesario ningún cambio en la inicialización del SDK.

Cambios de configuración del SDK

Algunas propiedades de configuración se han movido o renombrado para respaldar la modularidad en los SDKs nativos de Datadog.

Se ha cambiado el nombre de las siguientes estructuras:

Las siguientes propiedades han cambiado:

Además, han cambiado las siguientes API:

Cambios de Flutter Web

Los clientes que utilicen Flutter Web deben actualizarse para utilizar el SDK de navegador de Datadog v5. Cambia la siguiente importación en tu index.html:

-  <script type="text/javascript" src="https://www.datadoghq-browser-agent.com/datadog-logs-v4.js"></script>
-  <script type="text/javascript" src="https://www.datadoghq-browser-agent.com/datadog-rum-slim-v4.js"></script>
+  <script type="text/javascript" src="https://www.datadoghq-browser-agent.com/us1/v5/datadog-logs.js"></script>
+  <script type="text/javascript" src="https://www.datadoghq-browser-agent.com/us1/v5/datadog-rum-slim.js"></script>

Nota: Datadog proporciona un paquete CDN por sitio. Consulta README del SDK de navegador para obtener una lista de todas las URLs de los sitios.

Cambios en los productos de logs

Al igual que en v1, el registro de Datadog puede activarse configurando el miembro DatadogConfiguration.loggingConfiguration. Sin embargo, a diferencia de v1, Datadog no crea un registrador por defecto para ti. DatadogSdk.logs es ahora una instancia de DatadogLogging, que puede usarse para crear logs. Muchas opciones se han movido a DatadogLoggerConfiguration para dar a los desarrolladores una compatibilidad más detallada sobre registradores individuales.

Las siguientes API han cambiado:

Cambios en los productos de RUM

Las siguientes API han cambiado:

Además, los asignadores de evento ya no permiten modificar los nombres de sus vistas. Para cambiar el nombre de una vista, utiliza en su lugar un ViewInfoExtractor personalizado.