Personaliza los informes de fallas de Firebase Crashlytics

iOS+ Android Flutter Unity

En el panel de Crashlytics, puedes hacer clic en un problema para obtener un informe detallado del evento. Puedes personalizar esos informes para comprender mejor lo que sucede en tu app y las circunstancias de los eventos informados a Crashlytics.

• Instrumenta tu app para registrar claves personalizadas, mensajes de registro personalizados y, además, identificadores de usuario.

• Informa excepciones a Crashlytics.

• Obtén automáticamente registros de rutas de navegación si tu app usa el SDK de Firebase para Google Analytics. Estos registros te brindan visibilidad sobre las acciones del usuario que conducen a un evento recopilado por Crashlytics en tu app.

• Desactiva los informes de fallas automáticos y habilita los informes de aceptación para tus usuarios. Ten en cuenta que, de forma predeterminada, Crashlytics recopila informes de fallas de todos los usuarios de tu app automáticamente.

Agrega claves personalizadas

Las claves personalizadas te ayudan a obtener el estado específico de la app hasta el momento de la falla. Puedes asociar pares clave-valor arbitrarios con tus informes de fallas y, luego, usar las claves personalizadas para buscar y filtrar informes de fallas en Firebase console.

• En el panel de Crashlytics, puedes buscar problemas que coincidan con una clave personalizada.
• Cuando revises un problema específico en la consola, podrás ver las claves personalizadas asociadas a cada evento (pestaña secundaria Claves) y filtrar los eventos por claves personalizadas (menú Filtrar en la parte superior de la página).

Nota: Crashlytics admite un máximo de 64 pares clave-valor. Cuando alcances este límite, no se guardarán los valores adicionales. Cada par clave-valor puede tener un tamaño máximo de 1 KB.

Usa el método setCustomValue para establecer pares clave-valor: Por ejemplo:

Swift

// Set int_key to 100.
Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set str_key to "hello".
Crashlytics.crashlytics().setCustomValue("hello", forKey: "str_key")

Objective-C

Cuando configures números enteros, valores booleanos o números de punto flotante, enmarca el valor como @(value).

// Set int_key to 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set str_key to "hello".
[[FIRCrashlytics crashlytics] setCustomValue:@"hello" forKey:@"str_key"];

También puedes modificar el valor de una clave existente llamando a la clave y configurándola con un valor diferente. Por ejemplo:

Swift

Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set int_key to 50 from 100.
Crashlytics.crashlytics().setCustomValue(50, forKey: "int_key")

Objective-C

[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set int_key to 50 from 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(50) forKey:@"int_key"];

Para agregar pares clave-valor de forma masiva, usa el método setCustomKeysAndValues con un NSDictionary como único parámetro:

Swift

let keysAndValues = [
                 "string key" : "string value",
                 "string key 2" : "string value 2",
                 "boolean key" : true,
                 "boolean key 2" : false,
                 "float key" : 1.01,
                 "float key 2" : 2.02
                ] as [String : Any]

Crashlytics.crashlytics().setCustomKeysAndValues(keysAndValues)

Objective-C

NSDictionary *keysAndValues =
    @{@"string key" : @"string value",
      @"string key 2" : @"string value 2",
      @"boolean key" : @(YES),
      @"boolean key 2" : @(NO),
      @"float key" : @(1.01),
      @"float key 2" : @(2.02)};

[[FIRCrashlytics crashlytics] setCustomKeysAndValues: keysAndValues];

Agrega mensajes de registro personalizados

Para darte más contexto sobre los eventos que se produjeron antes de una falla, puedes agregar registros personalizados de Crashlytics a la app. Crashlytics asocia los registros con los datos de fallas y los hace visibles en la página de Crashlytics de Firebase console, en la pestaña Registros.

Nota: Para evitar que la app se ralentice, Crashlytics limita los registros a 64 kB y borra las entradas de registro anteriores cuando los registros de una sesión superan ese límite.

Swift

Usa log() o log(format:, arguments:) para identificar problemas. Si deseas obtener un resultado de registro útil con mensajes, el objeto que pases a log() debe cumplir con la propiedad CustomStringConvertible. log() muestra la propiedad de descripción que defines para el objeto. Por ejemplo:

Crashlytics.crashlytics().log("Higgs-Boson detected! Bailing out…, \(attributesDict)")

.log(format:, arguments:) da formato a los valores que se muestran después de llamar a getVaList(). Por ejemplo:

Crashlytics.crashlytics().log(format: "%@, %@", arguments: getVaList(["Higgs-Boson detected! Bailing out…", attributesDict]))

Para obtener más detalles acerca de cómo usar log() o log(format:, arguments:), consulta la documentación de referencia de Crashlytics.

Objective-C

Usa log o logWithFormat para identificar problemas. Ten presente que, si deseas obtener un resultado de registro útil con mensajes, el objeto que pases a cualquiera de los métodos debe anular la propiedad de instancia description. Por ejemplo:

[[FIRCrashlytics crashlytics] log:@"Simple string message"];

[[FIRCrashlytics crashlytics] logWithFormat:@"Higgs-Boson detected! Bailing out... %@", attributesDict];

[[FIRCrashlytics crashlytics] logWithFormat:@"Logging a variable argument list %@" arguments:va_list_arg];

Para obtener más detalles acerca de cómo usar log y logWithFormat, consulta la documentación de referencia de Crashlytics.

Configura identificadores de usuarios

Para diagnosticar un problema, resulta útil saber cuáles de tus usuarios sufrieron una falla. Crashlytics incluye una manera de identificar usuarios de forma anónima en los informes de fallas.

Para agregar los ID de usuario a tus informes, asigna a cada usuario un identificador único con el formato de un número de ID, un token o un valor de hash:

Swift

Crashlytics.crashlytics().setUserID("123456789")

Objective-C

[[FIRCrashlytics crashlytics] setUserID:@"123456789"];

Si en algún momento necesitas borrar un identificador de usuario después de configurarlo, restablece el valor a una string en blanco. Borrar un identificador de usuario no quita los registros de Crashlytics existentes. Si necesitas borrar los registros asociados con un ID de usuario, comunícate con el equipo de asistencia de Firebase.

Obtén registros de rutas de navegación

Los registros de rutas de navegación te permiten comprender mejor las interacciones que un usuario tuvo con tu app que desencadenaron el evento de falla, recuperable o de ANR. Estos registros pueden ser útiles cuando se intenta reproducir y depurar un problema.

Los registros de rutas de navegación se basan en Google Analytics, por lo que, para obtenerlos, debes habilitar Google Analytics para tu proyecto de Firebase y agregar el SDK de Firebase para Google Analytics a tu app. Una vez que se cumplan estos requisitos, los registros de rutas de navegación se incluyen automáticamente con los datos de un evento en la pestaña Registros cuando ves los detalles de un problema.

El SDK de Analytics registra automáticamente el evento screen_view, lo que permite que los registros de rutas de navegación muestren una lista de pantallas vistas antes del evento de falla, recuperable o de ANR. Un registro de rutas de navegación screen_view contiene un parámetro firebase_screen_class.

Los registros de rutas de navegación también se completan con cualquier evento personalizado que registres de forma manual en la sesión del usuario, incluidos los datos de los parámetros del evento. Estos datos pueden ayudar a mostrar una serie de acciones del usuario que desencadenaron un evento de falla, recuperable o de ANR.

Ten en cuenta que puedes controlar la recopilación y el uso de los datos de Google Analytics, que incluyen los datos que propagan los registros de rutas de navegación.

Habilita los informes de aceptación

Si habilitas los informes de aceptación inhabilitando los informes automáticos, reducirás la exactitud del recuento de eventos y las métricas sin fallas de tu app, lo que hará que reflejen en menor medida la estabilidad general de tu app. Obtén más información.

Según la configuración predeterminada, Crashlytics recopila informes de fallas de todos los usuarios de la app automáticamente. Para permitir que los usuarios tengan más control sobre los datos que envían, puedes habilitar los informes de aceptación si inhabilitas los informes automáticos y solo envías datos a Crashlytics cuando lo decidas en tu código.

1. Agrega una clave nueva al archivo Info.plist para desactivar la recopilación automática:

   • Clave: FirebaseCrashlyticsCollectionEnabled
   • Valor: false

2. Habilita la recopilación para usuarios específicos; para ello, llama la anulación de recopilación de datos de Crashlytics durante el tiempo de ejecución. El valor de anulación persiste en todos los lanzamientos posteriores de tu app para que Crashlytics pueda recopilar informes automáticamente para ese usuario.

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

   Si el usuario inhabilita la recopilación de datos más adelante, puedes pasar false como el valor de anulación, que se aplicará la próxima vez que el usuario inicie la app y persistirá en todos los inicios posteriores de ese usuario.

Nota: Cuando se inhabilita la recopilación de datos para un usuario, Crashlytics almacenará la información de fallas de forma local en el dispositivo. Si después se habilita la recopilación de datos, toda la información de fallas almacenada en el dispositivo se enviará a Crashlytics para procesarla.

Administra los datos de Crash Insights

Crash Insights te ayuda a resolver problemas a través de la comparación de tus seguimientos de pila anonimizados con seguimientos de otras apps de Firebase y te permite saber si tu problema es parte de una tendencia mayor. En muchos casos, Crash Insights incluso proporciona recursos para ayudarte a depurar la falla.

Crash Insights usa datos de fallas globales para identificar las tendencias de estabilidad comunes. Si prefieres no compartir los datos de la app, puedes inhabilitar esta función en el menú Crash Insights ubicado en la parte superior de la lista de problemas de Crashlytics de Firebase console.

Nota: Si inhabilitas el uso compartido de los datos, también se quitarán las estadísticas de tus problemas. Los cambios pueden tardar hasta 24 horas en aplicarse.