Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unità

Questa guida descrive come personalizzare i rapporti sugli arresti anomali utilizzando l'SDK Firebase Crashlytics. Per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali per tutti gli utenti della tua app (puoi disattivare i rapporti automatici sugli arresti anomali e abilitare invece i rapporti opt-in per i tuoi utenti). Crashlytics fornisce quattro meccanismi di registrazione predefiniti: 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 Firebase.

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

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Dopo aver raggiunto questa soglia, i valori aggiuntivi non vengono salvati. Ogni coppia chiave/valore può avere una dimensione massima di 1 kB.

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

Rapido

// 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, inserire 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"];

È inoltre possibile modificare il valore di una chiave esistente chiamando la chiave e impostandola su un valore diverso. Per esempio:

Rapido

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:

Rapido

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 log personalizzati

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

Nota: per evitare di rallentare la tua app, Crashlytics limita i log a 64 kB ed elimina le voci di log meno recenti quando i log di una sessione superano tale limite.

Rapido

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

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

.log(format:, arguments:) formatta i valori restituiti dalla chiamata 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:) , fai riferimento alla documentazione di riferimento di Crashlytics .

Obiettivo-C

Usa log o logWithFormat per aiutare a individuare i problemi. Si noti che se si desidera ottenere un utile output di log con i messaggi, l'oggetto che si passa a entrambi i metodi deve eseguire l'override della proprietà dell'istanza 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 maggiori dettagli su come utilizzare log e logWithFormat , fai riferimento alla documentazione di riferimento di Crashlytics .

Imposta 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 in modo anonimo gli utenti nei rapporti sugli arresti anomali.

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

Rapido

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 devi eliminare i record associati a un ID utente, contatta l'assistenza di Firebase .

Segnala eccezioni non irreversibili

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

Nota: Crashlytics memorizza solo le otto eccezioni più recenti in una determinata sessione dell'app. Se la tua app genera più di otto eccezioni in una sessione, le eccezioni meno recenti vengono perse.

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

Rapido

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

Obiettivo-C

[[FIRCrashlytics crashlytics] recordError:error];

Quando si utilizza il metodo recordError , è importante comprendere la struttura NSError e il modo in cui Crashlytics utilizza i dati per raggruppare gli arresti anomali. L'uso errato del metodo recordError può causare un comportamento imprevedibile e può 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 irreversibili, che vengono raggruppati tramite l'analisi della traccia dello stack, gli errori registrati vengono raggruppati per domain e code . Questa è un'importante distinzione tra arresti anomali fatali ed errori registrati. Per esempio:

Rapido

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 precedente, viene creato un nuovo problema raggruppato per NSSomeErrorDomain e -1001 . Ulteriori errori registrati che utilizzano lo stesso dominio e gli stessi valori di codice vengono 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.

Attenzione: evitare di utilizzare valori univoci, come ID utente, ID prodotto e timestamp nei campi del dominio e del codice. L'utilizzo di valori univoci in questi campi causa un'elevata cardinalità di problemi e potrebbe comportare la necessità da parte di Crashlytics di limitare la segnalazione degli errori registrati nella tua app. I valori univoci dovrebbero invece essere aggiunti all'oggetto dizionario userInfo .

Log e chiavi personalizzate

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

Considerazioni sulle prestazioni

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

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 dell'analisi dello stack corrente.

E le NSException?

Crashlytics non offre una funzione per la registrazione e la registrazione diretta delle istanze NSException . In generale, le API Cocoa e Cocoa Touch non sono a prova di eccezione. 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 istruzioni @catch nel tuo codice. Si prega di fare riferimento alla documentazione di Apple sull'argomento.

Personalizza le tracce dello stack

Se la tua app viene eseguita in un ambiente non nativo (come C++ o Unity), puoi utilizzare l'API del modello di eccezione per segnalare i metadati di arresto anomalo nel formato di eccezione nativo della tua app. Le eccezioni segnalate sono contrassegnate come non irreversibili.

Rapido

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:

Rapido

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 opt-in

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

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

   • Chiave: FirebaseCrashlyticsCollectionEnabled
   • Valore: false

2. Abilita la raccolta per utenti selezionati chiamando l'override della raccolta dati di Crashlytics in fase di esecuzione. Il valore di override persiste tra gli avvii della tua app in modo che Crashlytics possa raccogliere automaticamente i report.

   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.

   Rapido

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Obiettivo-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Nota: quando la raccolta dei dati è disabilitata, Crashlytics memorizzerà le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene successivamente abilitata, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.

Gestisci i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando le tue tracce dello stack anonime con le tracce di altre app Firebase e facendoti sapere 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 .