Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

Nella dashboard di Crashlytics, puoi fare clic su un problema e ottenere un rapporto dettagliato sull'evento. Puoi personalizzare questi report per aiutarti a comprendere meglio cosa sta succedendo nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

  • Ottieni automaticamente i log breadcrumb se la tua app utilizza l'SDK Firebase per Google Analytics. Questi log ti offrono visibilità sulle azioni degli utenti che portano a un evento raccolto da Crashlytics nella tua app.

  • Disattiva la segnalazione automatica degli arresti anomali e abilita la segnalazione di attivazione per i tuoi utenti. Tieni presente che, per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali per tutti gli utenti della tua app.

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app che ha portato 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 a ciascun evento (sottoscheda Chiavi ) e persino filtrare gli eventi in base alle chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Utilizza il metodo setCustomValue per impostare 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 in virgola mobile, racchiudere 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 avere più contesto per gli eventi che portano a un arresto anomalo, puoi aggiungere log Crashlytics personalizzati alla tua app. Crashlytics associa i log ai dati sugli arresti anomali e li visualizza nella pagina Crashlytics della console Firebase , nella scheda Log .

Veloce

Utilizza log() o log(format:, arguments:) per individuare i problemi. Se desideri 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à descrittiva 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 ulteriori dettagli su come utilizzare log() o log(format:, arguments:) , fare riferimento alla documentazione di riferimento di Crashlytics.

Obiettivo-C

Utilizza log o logWithFormat per individuare i problemi. Tieni presente che se desideri ottenere un output di log utile con i messaggi, l'oggetto che passi a uno dei metodi deve sovrascrivere la 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 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 in modo anonimo gli utenti 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 mai fosse 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 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 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 potrebbe 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 vengono raggruppati tramite l'analisi dello stack trace, gli errori registrati sono raggruppati per domain e code . Si tratta di una distinzione importante 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 registri 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 sono raggruppati nello stesso problema. I dati contenuti nell'oggetto userInfo vengono convertiti in coppie chiave-valore e visualizzati nella sezione chiavi/log all'interno di un singolo problema.

Registri e chiavi personalizzate

Proprio come i report 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 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 si chiude immediatamente. Poiché Crashlytics invia il report degli errori registrati solo al successivo avvio dell'app e deve limitare la quantità di spazio allocato per i log su disco, è possibile registrare abbastanza dopo la registrazione di un NSError in modo che tutti i log rilevanti vengano ruotati prima del momento in cui Crashlytics invia il rapporto dal dispositivo. Tieni presente questo equilibrio quando registri NSErrors e usi 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 un utilizzo intensivo della CPU e degli I/O, in particolare sulle architetture che supportano lo svolgimento DWARF (arm64 e x86). Una volta completata la rimozione, 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 dell'analisi dello stack corrente.

E le NSException?

Crashlytics non offre una funzionalità per il logging 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 processo, anche se usato con estrema cautela. Non dovresti mai usare le istruzioni @catch nel tuo codice. Fare riferimento alla documentazione di Apple sull'argomento.

Personalizza le analisi 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 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];

Gli stack frame personalizzati possono anche essere inizializzati solo con 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];

Ottieni i log breadcrumb

I log breadcrumb ti offrono una migliore comprensione delle interazioni che un utente ha avuto con la tua app prima di un arresto anomalo, di un evento non fatale o di un evento ANR. Questi log possono essere utili quando si tenta di riprodurre ed eseguire il debug di un problema.

I log breadcrumb sono forniti da Google Analytics, quindi per ottenere i log breadcrumb devi abilitare Google Analytics per il tuo progetto Firebase e aggiungere l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i registri breadcrumb vengono automaticamente inclusi con i dati di un evento nella scheda Registri quando visualizzi i dettagli di un problema.

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

I log breadcrumb vengono inoltre popolati con eventuali eventi personalizzati registrati manualmente nella sessione dell'utente, inclusi i dati dei parametri dell'evento. Questi dati possono aiutare a mostrare una serie di azioni dell'utente che portano a un arresto anomalo, a un evento non fatale 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 breadcrumb.

Abilita il reporting di attivazione

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 il reporting disattivando il reporting automatico e inviando i dati a Crashlytics solo quando lo scegli 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 i lanci 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.

    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 tue tracce di 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 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 Crash Insights nella parte superiore dell'elenco dei problemi di Crashlytics nella console Firebase .