Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

Questa guida descrive come personalizzare i rapporti sugli arresti anomali utilizzando Firebase Crashlytics SDK. Per impostazione predefinita, Crashlytics raccoglie automaticamente i rapporti sugli arresti anomali per tutti gli utenti della tua app (puoi invece disattivare i rapporti automatici sugli arresti anomali e abilitare i rapporti di attivazione per i tuoi utenti). Crashlytics fornisce quattro meccanismi di registrazione pronti all'uso: chiavi personalizzate , registri personalizzati , identificatori utente ed eccezioni rilevate .

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app che porta a un arresto anomalo. Puoi associare coppie chiave/valore arbitrarie ai rapporti sugli arresti anomali, quindi utilizzare le chiavi personalizzate per cercare e filtrare i rapporti sugli arresti anomali nella console di Firebase.

  • Nella dashboard di Crashlytics puoi cercare problemi che corrispondono a una chiave personalizzata.
  • Quando stai esaminando un problema specifico nella console, puoi visualizzare le chiavi personalizzate associate per ciascun evento (sottoscheda Chiavi ) e persino filtrare gli eventi in base alle chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Utilizzare il metodo setCustomValue per impostare le coppie chiave/valore. Per esempio:

Veloce

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

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

Obiettivo-C

Quando si impostano numeri interi, booleani o float, contrassegnare il valore come @( 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"];

Puoi anche modificare il valore di una chiave esistente chiamando la chiave e impostandola su un valore diverso. Per esempio:

Veloce

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

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

Obiettivo-C

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

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

Aggiungi coppie chiave/valore in blocco utilizzando il metodo setCustomKeysAndValues ​​con un NSDictionary come unico parametro:

Veloce

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)

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

Aggiungi messaggi di registro personalizzati

Per darti più contesto per gli eventi che hanno portato a un arresto anomalo, puoi aggiungere registri Crashlytics personalizzati alla tua app. Crashlytics associa i registri ai dati sugli arresti anomali e li visualizza nella pagina Crashlytics della console Firebase , nella scheda Registri .

Veloce

Usa log() o log(format:, arguments:) per aiutare a individuare i problemi. Se si desidera ottenere un output di log utile con i messaggi, l'oggetto che si passa a log() deve essere conforme alla proprietà CustomStringConvertible . log() restituisce la proprietà description definita per l'oggetto. Per esempio:

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

.log(format:, arguments:) formatta i valori restituiti dalla chiamata a getVaList() . Per esempio:

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

Per maggiori dettagli su come utilizzare log() o log(format:, arguments:) , fare riferimento alla documentazione di riferimento di Crashlytics.

Obiettivo-C

Usa log o logWithFormat per individuare i problemi. Si noti che se si desidera ottenere un output di log utile con i messaggi, l'oggetto che si passa a uno dei metodi deve sovrascrivere la proprietà dell'istanza della description . Per esempio:

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

Per ulteriori dettagli su come utilizzare log e logWithFormat , fare riferimento alla documentazione di riferimento di Crashlytics.

Imposta gli identificatori utente

Per diagnosticare un problema, è spesso utile sapere quale dei tuoi utenti ha riscontrato un determinato arresto anomalo. Crashlytics include un modo per identificare gli utenti in modo anonimo nei rapporti sugli arresti anomali.

Per aggiungere ID utente ai tuoi rapporti, assegna a ciascun utente un identificatore univoco sotto forma di numero ID, token o valore hash:

Veloce

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

Obiettivo-C

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

Se è necessario cancellare un identificatore utente dopo averlo impostato, reimpostare il valore su una stringa vuota. La cancellazione di un identificatore utente non rimuove i record Crashlytics esistenti. Se è necessario eliminare i record associati a un ID utente, contattare l'assistenza Firebase .

Segnala eccezioni non fatali

Oltre a segnalare automaticamente gli arresti anomali della tua app, Crashlytics ti consente di registrare eccezioni non fatali e te le invia al successivo avvio dell'app.

È possibile registrare eccezioni non irreversibili registrando oggetti NSError con il metodo recordError . recordError acquisisce lo stack di chiamate del thread chiamando [NSThread callStackReturnAddresses] .

Veloce

Crashlytics.crashlytics().record(error: error)

Obiettivo-C

[[FIRCrashlytics crashlytics] recordError:error];

Quando si utilizza il metodo recordError , è importante comprendere la struttura di NSError e il modo in cui Crashlytics utilizza i dati per raggruppare gli arresti anomali. L'utilizzo non corretto del metodo recordError può causare un comportamento imprevedibile e far sì che Crashlytics limiti la segnalazione degli errori registrati per la tua app.

Un oggetto NSError ha tre argomenti:

  • domain: String
  • code: Int
  • userInfo: [AnyHashable : Any]? = nil

A differenza degli arresti anomali fatali, che sono raggruppati tramite l'analisi della traccia dello stack, gli errori registrati sono raggruppati per domain e code . Questa è un'importante distinzione tra arresti anomali fatali ed errori registrati. Per esempio:

Veloce

let userInfo = [
  NSLocalizedDescriptionKey: NSLocalizedString("The request failed.", comment: ""),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString("The response returned a 404.", comment: ""),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString("Does this page exist?", comment: ""),
  "ProductID": "123456",
  "View": "MainView"
]

let error = NSError.init(domain: NSCocoaErrorDomain,
                         code: -1001,
                         userInfo: userInfo)

Obiettivo-C

NSDictionary *userInfo = @{
  NSLocalizedDescriptionKey: NSLocalizedString(@"The request failed.", nil),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString(@"The response returned a 404.", nil),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString(@"Does this page exist?", nil),
  @"ProductID": @"123456",
  @"View": @"MainView",
};

NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain
                                     code:-1001
                                 userInfo:userInfo];

Quando si registra l'errore sopra, viene creato un nuovo problema raggruppato da NSSomeErrorDomain e -1001 . Ulteriori errori registrati che utilizzano lo stesso dominio e valori di codice sono raggruppati sotto lo stesso problema. I dati contenuti nell'oggetto userInfo vengono convertiti in coppie chiave-valore e visualizzati nella sezione chiavi/registri all'interno di un singolo problema.

Registri e chiavi personalizzate

Proprio come i rapporti sugli arresti anomali, puoi incorporare log e chiavi personalizzate per aggiungere contesto a NSError . Tuttavia, esiste una differenza tra i registri allegati agli arresti anomali rispetto agli errori registrati. Quando si verifica un arresto anomalo e l'app viene riavviata, i registri recuperati da Crashlytics dal disco sono quelli scritti fino al momento dell'arresto anomalo. Quando registri un NSError , l'app non si interrompe immediatamente. Poiché Crashlytics invia il rapporto di errore registrato solo al successivo avvio dell'app e deve limitare la quantità di spazio allocato per i log su disco, è possibile registrare un numero sufficiente di log dopo la registrazione di un NSError in modo che tutti i log rilevanti vengano ruotati fuori dal momento in cui Crashlytics invia il rapporto dal dispositivo. Tieni presente questo equilibrio quando registri NSErrors e usi i log e le chiavi personalizzate nella tua app.

Considerazioni sulle prestazioni

Tieni presente che la registrazione di un NSError può essere piuttosto costoso. Nel momento in cui effettui la chiamata, Crashlytics acquisisce lo stack di chiamate del thread corrente utilizzando un processo chiamato stack unwinding. Questo processo può richiedere CPU e I/O intensivo, in particolare su architetture che supportano lo svolgimento DWARF (arm64 e x86). Al termine dello svolgimento, le informazioni vengono scritte sul disco in modo sincrono. Ciò impedisce la perdita di dati in caso di arresto anomalo della riga successiva.

Sebbene sia sicuro chiamare questa API su un thread in background, ricorda che l'invio di questa chiamata a un'altra coda perde il contesto della traccia dello stack corrente.

E le NSExceptions?

Crashlytics non offre una funzione per la registrazione e la registrazione diretta di istanze NSException . In generale, le API Cocoa e Cocoa Touch non sono a prova di eccezioni. Ciò significa che l'uso di @catch può avere effetti collaterali indesiderati molto gravi nel tuo processo, anche se usato con estrema cura. Non dovresti mai usare le istruzioni @catch nel tuo codice. Fare riferimento alla documentazione di Apple sull'argomento.

Personalizza le tracce dello stack

Se l'app viene eseguita in un ambiente non nativo (come C++ o Unity), puoi usare l'API Exception Model per segnalare i metadati di arresto anomalo nel formato di eccezione nativo dell'app. Le eccezioni segnalate sono contrassegnate come non fatali.

Veloce

var  ex = ExceptionModel(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(symbol:"makeError", file:"handler.js", line:495),
  StackFrame(symbol:"then", file:"routes.js", line:102),
  StackFrame(symbol:"main", file:"app.js", line:12),
]

crashlytics.record(exceptionModel:ex)

Obiettivo-C

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithSymbol:@"makeError" file:@"handler.js" line:495],
  [FIRStackFrame stackFrameWithSymbol:@"then" file:@"routes.js" line:102],
  [FIRStackFrame stackFrameWithSymbol:@"main" file:@"app.js" line:12],
];

[[FIRCrashlytics crashlytics] recordExceptionModel:model];

I frame stack personalizzati possono anche essere inizializzati con solo indirizzi:

Veloce

var  ex = ExceptionModel.init(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(address:0xfa12123),
  StackFrame(address:12412412),
  StackFrame(address:194129124),
]

crashlytics.record(exceptionModel:ex)

Obiettivo-C

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithAddress:0xfa12123],
  [FIRStackFrame stackFrameWithAddress:12412412],
  [FIRStackFrame stackFrameWithAddress:194129124],
];


[[FIRCrashlytics crashlytics] recordExceptionModel:model];

Abilita i rapporti di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i rapporti sugli arresti anomali per tutti gli utenti della tua app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi abilitare i rapporti di attivazione disabilitando i rapporti automatici e inviando i dati a Crashlytics solo quando lo scegli nel tuo codice:

  1. Disattiva la raccolta automatica aggiungendo una nuova chiave al file Info.plist :

    • Chiave: FirebaseCrashlyticsCollectionEnabled
    • Valore: false
  2. Abilita la raccolta per utenti selezionati chiamando l'override della raccolta dei dati di Crashlytics in fase di esecuzione. Il valore di sostituzione persiste durante i lanci dell'app in modo che Crashlytics possa raccogliere automaticamente i rapporti.

    Per disattivare la segnalazione automatica degli arresti anomali, passare false come valore di sostituzione. Se impostato su false , il nuovo valore non si applica fino alla successiva esecuzione dell'app.

    Veloce

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Obiettivo-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Gestisci i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando le tracce dello stack anonime con le tracce di altre app Firebase e informandoti se il tuo problema fa parte di una tendenza più ampia. Per molti problemi, Crash Insights fornisce anche risorse per aiutarti a eseguire il debug dell'arresto anomalo.

Crash Insights utilizza i dati aggregati sugli arresti anomali per identificare le tendenze di stabilità comuni. Se preferisci non condividere i dati della tua app, puoi disattivare Crash Insights dal menu Crash Insights nella parte superiore dell'elenco dei problemi di Crashlytics nella console di Firebase .