Información general

Habilita Crash Reporting y Error Tracking de iOS para obtener informes completos de fallos y tendencias de errores. Con esta función, puedes acceder a:

• Dashboards y atributos de fallos agregados de iOS
• Informes simbolizados de fallos de iOS
• Análisis de tendencias con el seguimiento de errores de iOS

Para simbolizar tus trazas (traces) de stack tecnológico, busca y carga tus archivos .dSYM en Datadog. A continuación, verifica tu configuración ejecutando un test de fallos y reiniciando tu aplicación.

Tus informes de bloqueos aparecen en Error Tracking.

Compatibilidad

Consulta Versiones compatibles para ver una lista de versiones de sistemas operativos y plataformas compatibles con el SDK de iOS.

Configuración

Para empezar a enviar datos de Error Tracking desde tu aplicación iOS o tvOS a Datadog:

Paso 1: Declarar el SDK de iOS como dependencia

Declara la biblioteca iOS como dependencia en función de tu gestor de paquetes. Datadog recomienda utilizar Swift Package Manager (SPM).

.package(url: "https://github.com/Datadog/dd-sdk-ios.git", .upToNextMajor(from: "3.0.0"))

DatadogCore
DatadogRUM

pod 'DatadogCore'
pod 'DatadogRUM'

github "DataDog/dd-sdk-ios"

carthage bootstrap --use-xcframeworks --no-use-binaries

DatadogInternal.xcframework
DatadogCore.xcframework
DatadogRUM.xcframework

Paso 2: Especificar los detalles de la aplicación en la interfaz de usuario

1. Ve a Error Tracking > Settings > Browser and Mobile (Error Tracking > Configuración** > Navegador y móvil).
2. Haz clic en New Application (Nueva aplicación).
3. Introduce un nombre para la aplicación y selecciona iOS como tipo de aplicación.
4. Haz clic en Create Application (Crear aplicación) para generar un ID de aplicación y un token de cliente de Datadog únicos.

Paso 3: Inicializar la biblioteca

Actualizar el fragmento de inicialización

En el fragmento de inicialización, define un nombre de entorno y un nombre de servicio.

Para garantizar la seguridad de tus datos, debes utilizar un token de cliente. Si solo utilizaras claves de API Datadog para configurar la biblioteca dd-sdk-ios, se expondrían del lado del cliente en el código de bytes de la aplicación iOS.

Para obtener más información sobre cómo configurar un token de cliente, consulta la documentación sobre tokens de cliente.

El SDK debe inicializarse lo antes posible en el ciclo de vida de la aplicación, concretamente en la llamada de retorno application(_:didFinishLaunchingWithOptions:) de AppDelegate. Esto garantiza que todas las mediciones, incluida la duración del inicio de la aplicación, se capturen correctamente. Para aplicaciones compiladas con SwiftUI, puedes utilizar @UIApplicationDelegateAdaptor para conectarse al AppDelegate.

Para obtener más información, consulta Uso de etiquetas (tags).

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite eu1];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite us3];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite us5];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite us1_fed];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite ap1];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

import DatadogCore

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

@import DatadogCore;

DDConfiguration *configuration = [[DDConfiguration alloc] initWithClientToken:@"<client token>" env:@"<environment>"];
configuration.service = @"<service name>";
configuration.site = [DDSite ap2];

[DDDatadog initializeWithConfiguration:configuration
                       trackingConsent:trackingConsent];

Instrumentar tus vistas web (opcional)

Añade el módulo DatadogWebViewTracking utilizando tu gestor de dependencias preferido.

Para realizar un seguimiento de errores y problemas de rendimiento dentro del contenido web, activa el rastreo de vistas web para tus instancias WKWebView. Esto te permite monitorizar errores de JavaScript, solicitudes de red e interacciones de usuario que se producen en páginas web incrustadas, lo que te proporciona una visibilidad completa de los componentes web de tu aplicación híbrida.

Especifica los hosts en los que quieres realizar un seguimiento proporcionando una lista de dominios. Solo se monitoriza el contenido web de los hosts especificados y esto se informa a Datadog.

import DatadogWebViewTracking

let webview = WKWebView(...)

// start tracking webviews
WebViewTracking.enable(webView: webview, hosts: ["foo.bar"])

//stop tracking webviews (after the user stops navigating the web page)
WebViewTracking.disable(webView: webview)

Para obtener más información, consulta Seguimiento de vistas web.

Paso 4: Añadir la notificación de fallos

La notificación de fallos captura los fallos fatales que se producen cuando tu aplicación se cierra inesperadamente, además de los errores que Error Tracking muestra en una interfaz unificada.

Para activar la notificación de fallos, añade el paquete en función de tu gestor de dependencias y actualiza tu fragmento de inicialización.

.package(url: "https://github.com/Datadog/dd-sdk-ios.git", .upToNextMajor(from: "3.0.0"))

DatadogCrashReporting

pod 'DatadogCrashReporting'

github "DataDog/dd-sdk-ios"

DatadogCrashReporting.xcframework

Actualiza tu fragmento de inicialización para incluir Crash Reporting:

import DatadogCore
import DatadogCrashReporting

Datadog.initialize(...)

CrashReporting.enable()

Paso 5: Añadir la notificación de bloqueos de aplicaciones

Los bloqueos de aplicaciones son un tipo de error específico de iOS que se produce cuando la aplicación no responde durante un tiempo prolongado. Los bloqueos de aplicaciones se informan a través del SDK de iOS (no a través de logs). Por defecto, la notificación de bloqueos de aplicaciones está desactivada, pero puedes activarla y definir tu propio umbral para monitorizar bloqueos de aplicaciones que duren más de un periodo de tiempo que puedes especificar en el parámetro de inicialización appHangThreshold. Cuando está activado, cualquier pausa del subproceso principal que sea más prolongada que la especificada en appHangThreshold se considera un “bloqueo” en Error Tracking. Un umbral personalizable te permite encontrar el equilibrio adecuado entre la observabilidad detallada y ruidosa. Consulta Configurar el umbral de bloqueo de aplicaciones para obtener más información sobre la configuración de este valor.

Existen dos tipos de bloqueos:

• Bloqueo fatal de la aplicación: Cómo se informa de un bloqueo si nunca se recupera y se cierra la aplicación. Los bloqueos fatales de aplicaciones se marcan como “Fallo” en Error Tracking y en el Explorador RUM.

• Bloqueo no fatal de la aplicación: Cómo se informa de un bloqueo si la aplicación se recupera de un bloqueo relativamente breve y sigue ejecutándose. Los bloqueos no fatales de aplicaciones no se marcan como “Fallo” en Error Tracking y en el Explorador RUM.

RUM.enable(
    with: RUM.Configuration(
        applicationID: "<application id>",
        appHangThreshold: 2.0  // Report hangs lasting 2+ seconds
    )
)

Paso 6: Obtener trazas de stack tecnológico desofuscadas

Los informes de fallos se recopilan en un formato no procesado y contienen principalmente direcciones de memoria. Para convertir estas direcciones en información con símbolos legibles (proceso llamado desofuscación), Datadog necesita archivos dSYM, que se generan durante el proceso de compilación o distribución de tu aplicación.

Nota: Error Tracking admite la simbolización de archivos de símbolos del sistema para la arquitectura arm64 y arm64e de IOS v14 o posterior. El tamaño de los archivos .dSYM está limitado a 2 GB cada uno.

Para ayudarte a depurar errores, Datadog utiliza un ID de compilación único generado para desofuscar trazas de stack tecnológico, emparejándolas con sus archivos de asignación correspondientes. Este proceso tiene lugar independientemente de si los archivos de asignación se han cargado durante las compilaciones de preproducción o de producción, lo que garantiza que la información correcta esté disponible para procesos de control de calidad eficientes al revisar fallos y errores en Datadog.

Para las aplicaciones iOS, la coincidencia de las trazas de stack tecnológico y los archivos de símbolos se basa en su campo uuid.

export DATADOG_API_KEY="<API KEY>"

// if you have a zip file containing dSYM files
npx @datadog/datadog-ci dsyms upload appDsyms.zip

// if you have a folder containing dSYM files
npx @datadog/datadog-ci dsyms upload /path/to/appDsyms/

# For EU endpoint
export DATADOG_SITE="datadoghq.eu"
export DATADOG_API_KEY="<API KEY>"
npx @datadog/datadog-ci dsyms upload appDsyms.zip

# For custom intake URL
export DATADOG_DSYM_INTAKE_URL="https://your-custom-endpoint.com"
export DATADOG_API_KEY="<API KEY>"
npx @datadog/datadog-ci dsyms upload appDsyms.zip

name: Upload dSYM Files

jobs:
  build:
    runs-on: macos-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Generate/Download dSYM Files
        uses: ./release.sh

      - name: Upload dSYMs to Datadog
        uses: DataDog/upload-dsyms-github-action@v1
        with:
          api_key: ${{ secrets.DATADOG_API_KEY }}
          site: datadoghq.com
          dsym_paths: |
            path/to/dsyms/folder
            path/to/zip/dsyms.zip

Para test tu implementación

Para verificar tu configuración de Crash Reporting y Error Tracking de iOS, emite un fallo en tu aplicación y confirma que el error aparece en Datadog.

1. Ejecuta tu aplicación en un simulador iOS o dispositivo real. Asegúrate de que el depurador no está conectado. De lo contrario, Xcode captura el fallo antes de que lo haga el SDK de iOS.

2. Ejecuta el código que contiene el fallo:

   func didTapButton() {
   fatalError("Crash the app")
   }
   

3. Después de que se produzca el fallo, reinicia tu aplicación y espera a que el SDK de iOS cargue el informe del fallo en Error Tracking.

Funciones avanzadas de Error Tracking

let configuration = RUM.Configuration(
    applicationID: "<application id>",
    sessionSampleRate: 50
)

DDRUMConfiguration *configuration = [[DDRUMConfiguration alloc] initWithApplicationID:@"<application id>"];
configuration.sessionSampleRate = 50;

Referencias adicionales

Más enlaces, artículos y documentación útiles:

Código fuente de dd-sdk-iosCÓDIGO FUENTE