Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS e versioni successive Android Flusso Unità

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 breadcrumb se la tua app utilizza la 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 per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti i tuoi utenti dell'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).

di Gemini Advanced.

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

Utilizza il metodo setCustomValue per impostare 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, booleani o numeri in virgola mobile, inserisci il valore @(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];

Aggiungere 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

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 log() deve essere conforme ai CustomStringConvertible proprietà. log() restituisce la proprietà della descrizione che definisci dell'oggetto. Ad esempio:

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

Valori dei formati .log(format:, arguments:) restituiti dalle chiamate 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

Utilizza 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 anonimamente gli utenti nei report sugli arresti anomali.

Per aggiungere gli ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore sottoposta ad hashing:

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 archivia solo le otto eccezioni più recenti in una determinata sessione app. Se la tua app genera più di otto eccezioni in una sessione, i valori precedenti le eccezioni 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. Si tratta di 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. Altri errori registrati che utilizzano lo stesso dominio e codice sono raggruppati nello stesso problema. I dati contenuti in L'oggetto userInfo viene convertito in coppie chiave/valore e visualizzato nello di chiavi/log all'interno di un singolo problema.

Attenzione :evita 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 determina un cardinalità dei problemi e potrebbe comportare la necessità da parte di Crashlytics di limitare la generazione di report sugli errori registrati nell'app. I valori univoci devono invece essere aggiunti l'oggetto dizionario userInfo.

Log e chiavi personalizzate

Come per i report sugli arresti anomali, puoi incorporare log e chiavi personalizzate per aggiungere contesto NSError. Tuttavia, c'è una differenza nel modo in cui sono collegati i log ed errori registrati. Quando si verifica un arresto anomalo e l'app viene riavviata, i log che Crashlytics recupera dal disco sono quelli scritti fino al momento dell'arresto anomalo. Quando registri un NSError, l'app non esegue immediatamente o risolvere il problema. 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 il logging di un NSError può essere piuttosto costoso. 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 in caso di arresto anomalo della riga successiva.

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 per le eccezioni. Ciò significa che l'utilizzo di @catch può causare gravi effetti collaterali nel processo, anche se utilizzato con estrema cura. Non dovresti mai utilizza le 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 di arresto anomalo nell'eccezione nativa dell'app formato. 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 dei breadcrumb sono basati su Google Analytics, quindi per ottenere i log dei breadcrumb, necessario abilita Google Analytics per il tuo progetto Firebase aggiungi l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i log dei breadcrumb vengono automaticamente inclusione dei 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 delle schermate visualizzate prima del di un evento di arresto anomalo, non irreversibile o ANR. Un log breadcrumb screen_view contiene un 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 aiutare a mostrare una serie di azioni utente che hanno portato a un evento di arresto anomalo, non irreversibile o ANR.

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

Attiva i report di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali relativi a tutti i tuoi utenti dell'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 di override viene mantenuto della tua 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 del 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 a livello locale 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

Crash Insights ti aiuta a risolvere i problemi confrontando il tuo stack anonimo da altre app Firebase e ti comunica se il problema è parte di una tendenza più ampia. Per molti problemi, Crash Insights fornisce anche per eseguire il debug dell'arresto anomalo.

Crash Insights utilizza dati aggregati sugli arresti anomali per identificare 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. Le modifiche potrebbero possono trascorrere fino a 24 ore prima che le modifiche diventino effettive.