Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unity

Nella dashboard di Crashlytics, puoi fare clic su un problema e visualizzare report sugli eventi. Puoi personalizzare questi report per comprendere meglio cosa succede nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

• Instrumenta la tua app per registrare chiavi personalizzate, messaggi di log personalizzati e identificatori utente.

• Segnala le eccezioni a Crashlytics.

• Ricevi automaticamente i log dei breadcrumb se la tua app utilizza la classe SDK Firebase per Google Analytics. Questi log ti offrono visibilità Azioni utente che hanno portato a un evento raccolto da Crashlytics nella tua app.

• Disattivare i report automatici sugli arresti anomali e abilitare i report di attivazione per i tuoi utenti. Tieni presente che, per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app.

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti consentono di conoscere lo stato specifico della tua app che ha causato un arresto anomalo. Puoi associare coppie chiave/valore arbitrarie ai report sugli arresti anomali, quindi utilizzare le chiavi personalizzate per cercare e filtrare i report 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 chiavi personalizzate associate a ogni evento (scheda Chiavi) e persino filtrare gli eventi per chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Una volta raggiunta questa soglia, i valori aggiuntivi non vengono salvati. Ogni coppia chiave/valore può non superiore a 1 kB.

Utilizza il metodo setCustomValue per impostare le coppie chiave/valore. Ad esempio:

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

Quando imposti numeri interi, valori booleani o valori in virgola mobile, inserisci il valore in una casella 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 l'impostazione impostando un valore diverso. Ad esempio:

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

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

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

Aggiungi messaggi di log personalizzati

Per darti maggiore contesto sugli eventi che hanno portato a un arresto anomalo, puoi aggiungere log Crashlytics personalizzati nella tua app. Crashlytics associa i log con i dati relativi agli arresti anomali e li visualizza nella pagina Crashlytics dell' Console Firebase, nella scheda Log.

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

Swift

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

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

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

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

Per ulteriori dettagli su come utilizzare log() o log(format:, arguments:), consulta la Crashlytics documentazione di riferimento.

Objective-C

Usa log o logWithFormat per individuare i problemi. Tieni presente che vuoi ottenere un utile output di log con i messaggi, l'oggetto passato in entrambi i metodi devono eseguire l'override della proprietà dell'istanza description. Ad 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, consulta le Crashlytics documentazione di riferimento.

Impostare gli identificatori degli utenti

Per diagnosticare un problema, spesso è utile sapere quali utenti hanno riscontrato a un determinato arresto anomalo. Crashlytics include un modo per identificare in modo anonimo gli utenti in i tuoi report sugli arresti anomali.

Per aggiungere gli ID utente ai report, assegna a ciascun utente un identificatore univoco nella di un numero ID, di un token o di un valore hash:

Swift

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

Objective-C

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

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

Segnala eccezioni non irreversibili

Oltre a segnalare automaticamente gli arresti anomali dell'app, Crashlytics consente registri eccezioni non irreversibili e te le invia la prossima volta che l'app viene avviato.

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 più vecchie vengono perse.

Puoi registrare eccezioni non irreversibili registrando NSError oggetti con lo Metodo recordError. recordError acquisisce lo stack di chiamate del thread chiamando [NSThread callStackReturnAddresses].

Swift

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

Objective-C

[[FIRCrashlytics crashlytics] recordError:error];

Quando utilizzi il metodo recordError, è importante comprendere il NSError e in che modo Crashlytics usa i dati per raggruppare gli arresti anomali. Sbagliato l'utilizzo del metodo recordError può causare comportamenti imprevedibili e può causano Crashlytics la limitazione della 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, raggruppati tramite l'analisi dell'analisi dello stack, gli errori registrati sono raggruppate per domain e code. Questa è una distinzione importante tra arresti anomali irreversibili ed errori registrati. Ad esempio:

Swift

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)

Objective-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 l'errore viene registrato sopra, viene creato un nuovo problema raggruppato per NSSomeErrorDomain e -1001. Gli altri errori registrati che utilizzano gli stessi valori di dominio e codice sono raggruppati nello stesso problema. I dati contenuti nell'oggetto userInfo vengono convertiti in coppie chiave-valore e visualizzati nella sezione chiavi/log di un singolo problema.

Attenzione: evita di utilizzare valori univoci, come ID utente, ID prodotto e timestamp, nei campi dominio e codice. L'utilizzo di valori univoci in questi campi comporta un'elevata cardinalità dei problemi e potrebbe comportare la necessità per Crashlytics di limitare la registrazione degli errori registrati nella tua app. I valori univoci devono invece essere aggiunti all'oggetto dizionario userInfo.

Log e chiavi personalizzate

Come per i report sugli arresti anomali, puoi incorporare log e chiavi personalizzate per aggiungere contesto al NSError. Tuttavia, esiste una differenza tra i log associati ai crash e quelli associati agli errori registrati. Quando si verifica un arresto anomalo e l'app viene riavviata, i log recuperati da Crashlytics dal disco sono quelli scritti fino al momento dell'arresto anomalo. Quando registri un NSError, l'app non si chiude immediatamente. Poiché Crashlytics invia il report sugli errori registrati solo nella all'avvio successivo dell'app e deve limitare la quantità di spazio allocato per i log su disco. è possibile registrare abbastanza dati dopo che un NSError è stato registrato in modo che tutte le i log vengono ruotati nel momento in cui Crashlytics invia il report dall' dispositivo. Tieni presente questo saldo quando registri NSErrors e utilizzi i log e chiavi personalizzate nell'app.

Considerazioni sulle prestazioni

Tieni presente che la registrazione di un NSError può essere piuttosto costosa. Quando effettua la chiamata, Crashlytics acquisisce lo stack di chiamate del thread attuale utilizzando un un processo chiamato svolgimento dello stack. Questo processo può essere ad alta intensità di CPU e I/O, in particolare sulle architetture che supportano il unwinding DWARF (arm64 e x86). Al termine dell'operazione, le informazioni vengono scritte su disco in modo sincrono. In questo modo si evita la perdita di dati se la riga successiva dovesse bloccarsi.

Anche se è sicuro chiamare questa API su un thread in background, ricorda che l'invio di questa chiamata a un perde il contesto dell'analisi dello stack attuale.

E per quanto riguarda le NSEccezioni?

Crashlytics non offre una struttura per il logging e la registrazione NSException di Compute Engine. In generale, le API Cocoa e Cocoa Touch non sono esenti da eccezioni. Ciò significa che l'utilizzo di @catch può causare gravi effetti collaterali nel processo, anche se utilizzato con estrema cura. Non devi mai utilizzare istruzioni @catch nel codice. Consulta Documentazione di Apple sull'argomento.

Personalizza analisi dello stack

Se la tua app viene eseguita in un ambiente non nativo (ad esempio C++ o Unity), puoi utilizzare l'API Exception Model per segnalare i metadati degli arresti anomali nel formato delle eccezioni native della tua app. Le eccezioni segnalate sono contrassegnate come non irreversibili.

Swift

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)

Objective-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 dello stack personalizzati possono essere inizializzati anche solo con gli indirizzi:

Swift

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)

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

Recupera log dei breadcrumb

I log dei breadcrumb ti consentono di comprendere meglio le interazioni di un utente con la tua app che hanno portato a un arresto anomalo, a un evento non irreversibile o ANR. Questi log possono essere utile quando si cerca di riprodurre un problema ed eseguirne il debug.

I log breadcrumb sono basati su Google Analytics, quindi per ottenerli devi attivare Google Analytics per il tuo progetto Firebase e aggiungere l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i log breadcrumb vengono inclusi automaticamente con i dati di un evento nella scheda Log quando visualizzi i dettagli di un problema.

L'SDK Analytics registra automaticamente l'evento screen_view che consente ai log dei breadcrumb di mostrare un elenco di schermate visualizzate prima dell'evento di arresto anomalo, non irreversibile o ANR. Un log dei breadcrumb screen_view contiene un parametro firebase_screen_class.

I log dei breadcrumb vengono anche compilati con qualsiasi eventi personalizzati che registri manualmente nell'account dell'utente. sessione, inclusi i dati dei parametri dell'evento. Questi dati possono essere utili per mostrare una serie di azioni utente che hanno portato a un arresto anomalo, a un evento non irreversibile o ANR.

Tieni presente che puoi controllare la raccolta e l'utilizzo dei dati di Google Analytics, che includono i dati che popolano i log dei breadcrumb.

Attivare i report di attivazione

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

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

   • Chiave: FirebaseCrashlyticsCollectionEnabled
   • Valore: false

2. Attiva la raccolta per utenti selezionati richiamando i dati di Crashlytics l'override della raccolta in fase di runtime. Il valore dell'override persiste per tutti i lanci dell'app, in modo che Crashlytics possa raccogliere automaticamente i report.

   Per disattivare i report automatici sugli arresti anomali, trasmetti false come valore di override. Se impostato su false, il nuovo valore non viene applicato fino alla successiva esecuzione dell'app.

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Nota: se la raccolta dei dati è disattivata, Crashlytics archivierà gli arresti anomali informazioni locali sul dispositivo. Se la raccolta dei dati viene attivata successivamente, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.

Gestisci i dati di Crash Insights

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le analisi dello stack anonimizzate con quelle di altre app Firebase e ti informano se il problema fa parte di una tendenza più ampia. Per molti problemi, gli Approfondimenti sugli arresti anomali forniscono persino risorse per aiutarti a eseguire il debug dell'arresto anomalo.

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

Nota: la disattivazione della condivisione dei dati rimuove anche gli approfondimenti sui problemi. L'applicazione delle modifiche può richiedere fino a 24 ore.