Personaliza tus informes de fallos de Firebase Crashlytics

Esta guía describe cómo personalizar sus informes de fallas usando el SDK de Firebase Crashlytics. De forma predeterminada, Crashlytics recopila automáticamente informes de fallos para todos los usuarios de su aplicación (puede desactivar los informes de fallos automáticos y habilitar los informes de suscripción voluntaria para sus usuarios). Crashlytics proporciona cuatro mecanismos de registro listos para usar: claves personalizadas , registros personalizados , identificadores de usuario y excepciones detectadas .

Agregar claves personalizadas

Las claves personalizadas lo ayudan a obtener el estado específico de su aplicación antes de fallar. Puede asociar pares clave/valor arbitrarios con sus informes de fallos y luego usar las claves personalizadas para buscar y filtrar informes de fallos en Firebase console.

  • En el panel de Crashlytics , puede buscar problemas que coincidan con una clave personalizada.
  • Cuando revisa un problema específico en la consola, puede ver las claves personalizadas asociadas para cada evento (subpestaña Claves ) e incluso filtrar los eventos por claves personalizadas (menú Filtro en la parte superior de la página).

Utilice el método setCustomValue para establecer pares clave/valor. Por ejemplo:

Rápido

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

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

C objetivo

Al configurar números enteros, booleanos o flotantes, encuadre 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 puede modificar el valor de una clave existente llamando a la clave y configurándola en un valor diferente. Por ejemplo:

Rápido

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

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

C objetivo

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

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

Agregue pares clave/valor de forma masiva utilizando el método setCustomKeysAndValues ​​con un NSDictionary como único parámetro:

Rápido

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)

C objetivo

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];

Agregar mensajes de registro personalizados

Para tener más contexto sobre los eventos que conducen a un bloqueo, puede agregar registros personalizados de Crashlytics a su aplicación. Crashlytics asocia los registros con sus datos de fallas y los muestra en la página Crashlytics de Firebase console , en la pestaña Registros .

Rápido

Utilice log() o log(format:, arguments:) para ayudar a identificar problemas. Si desea obtener una salida de registro útil con mensajes, el objeto que pase a log() debe ajustarse a la propiedad CustomStringConvertible . log() devuelve la propiedad de descripción que define para el objeto. Por ejemplo:

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

.log(format:, arguments:) formatea los valores devueltos al llamar getVaList() . Por ejemplo:

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

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

C objetivo

Utilice log o logWithFormat para ayudar a identificar problemas. Tenga en cuenta que si desea obtener una salida de registro útil con mensajes, el objeto que pase 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 sobre cómo utilizar log y logWithFormat , consulte la documentación de referencia de Crashlytics.

Establecer identificadores de usuario

Para diagnosticar un problema, suele ser útil saber cuál de sus usuarios experimentó un bloqueo determinado. Crashlytics incluye una forma de identificar usuarios de forma anónima en sus informes de fallos.

Para agregar ID de usuario a sus informes, asigne a cada usuario un identificador único en forma de número de ID, token o valor hash:

Rápido

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

C objetivo

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

Si alguna vez necesita borrar un identificador de usuario después de configurarlo, restablezca el valor a una cadena en blanco. Borrar un identificador de usuario no elimina los registros de Crashlytics existentes. Si necesita eliminar registros asociados con una ID de usuario, comuníquese con el soporte de Firebase .

Habilitar informes de suscripción voluntaria

De forma predeterminada, Crashlytics recopila automáticamente informes de fallos para todos los usuarios de su aplicación. Para brindarles a los usuarios más control sobre los datos que envían, puede habilitar los informes de suscripción deshabilitando los informes automáticos y solo enviando datos a Crashlytics cuando así lo elija en su código:

  1. Desactive la recopilación automática agregando una nueva clave a su archivo Info.plist :

    • Clave: FirebaseCrashlyticsCollectionEnabled
    • Valor: false
  2. Habilite la recopilación para usuarios seleccionados llamando a la anulación de la recopilación de datos de Crashlytics en tiempo de ejecución. El valor de anulación persiste durante los lanzamientos de su aplicación para que Crashlytics pueda recopilar informes automáticamente.

    Para optar por no recibir informes automáticos de fallos, pase false como valor de anulación. Cuando se establece en false , el nuevo valor no se aplica hasta la siguiente ejecución de la aplicación.

    Rápido

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    C objetivo

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Administrar datos de Crash Insights

Crash Insights te ayuda a resolver problemas al comparar tus seguimientos de pila anónimos con los de otras aplicaciones de Firebase y te permite saber si tu problema es parte de una tendencia más amplia. Para muchos problemas, Crash Insights incluso proporciona recursos para ayudarle a depurar el fallo.

Crash Insights utiliza datos agregados sobre accidentes para identificar tendencias de estabilidad comunes. Si prefieres no compartir los datos de tu aplicación, puedes optar por no participar en Crash Insights desde el menú Crash Insights en la parte superior de tu lista de problemas de Crashlytics en Firebase console .