Personalizzare i report sugli arresti anomali per le piattaforme Apple

Seleziona la piattaforma:

iOS+ Android Flutter Unity

Puoi fare clic su un problema e ottenere un report dettagliato sugli eventi nella DevOps e coinvolgimento > Crashlytics dashboard della Firebase console. Puoi personalizzare questi report per comprendere meglio cosa sta succedendo nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

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

• Segnala le eccezioni a Crashlytics.

• Ricevi automaticamente i log dei breadcrumb se la tua app utilizza l' SDK Firebase per Google Analytics. Questi log ti consentono di visualizzare le azioni utente che hanno portato a un evento raccolto da Crashlytics nella tua app.

• Disattiva la segnalazione automatica degli arresti anomali e attiva la segnalazione con consenso esplicito 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.

Aggiungere 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 DevOps e coinvolgimento > Crashlytics dashboard della Firebase console.

• Puoi cercare i problemi che corrispondono a una chiave personalizzata.

• Quando esamini un problema specifico nella console, puoi visualizzare le chiavi personalizzate associate a ogni evento (scheda secondaria 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. Una volta raggiunto questo limite, i valori aggiuntivi non vengono salvati. Ogni coppia chiave-valore può avere una dimensione massima di 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 float, racchiudi il valore tra parentesi quadre 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. 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 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 avere più contesto per gli eventi che hanno portato 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 scheda Log quando visualizzi i dettagli di un problema (vedi tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase).

Nota: per evitare di rallentare l'app, Crashlytics limita i log a 64 kB ed elimina le voci di log precedenti 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 di log utile con i messaggi, l'oggetto che passi a log() deve essere conforme alla CustomStringConvertible proprietà. log() restituisce la proprietà di descrizione definita per l'oggetto. Ad esempio:

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

.log(format:, arguments:) formatta i valori restituiti dalla chiamata a 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, se vuoi ottenere un output di log utile con i messaggi, l'oggetto che passi a uno dei due metodi deve 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 ulteriori dettagli su come utilizzare log e logWithFormat, consulta la Crashlytics documentazione di riferimento.

Impostare gli identificatori utente

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

Per aggiungere ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore sottoposto 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 record esistenti Crashlytics. Se devi eliminare i record associati a un ID utente, contatta l'assistenza Firebase.

Segnalare eccezioni non irreversibili

Oltre a segnalare automaticamente gli arresti anomali dell'app, Crashlytics ti consente di registrare le eccezioni non irreversibili e di inviarle 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 precedenti vengono perse.

Puoi registrare le eccezioni non irreversibili registrando gli oggetti NSError con il 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 la struttura NSError e il modo in cui Crashlytics utilizza i dati per raggruppare gli arresti anomali. L'utilizzo errato 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 irreversibili, che vengono raggruppati tramite l'analisi dello stack trace, gli errori registrati vengono raggruppati per domain e code. Questa è una distinzione importante tra gli arresti anomali irreversibili e gli 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 registri l'errore sopra, viene creato un nuovo problema raggruppato per NSSomeErrorDomain e -1001. Gli errori registrati aggiuntivi che utilizzano gli stessi valori di dominio e codice vengono 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.

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 causa una cardinalità elevata dei problemi e potrebbe comportare la necessità per Crashlytics di limitare la segnalazione 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 a NSError. Tuttavia, esiste una differenza tra i log allegati agli arresti anomali e gli errori registrati. Quando si verifica un arresto anomalo e l'app viene riavviata, i log Crashlytics recuperati dal disco sono quelli scritti fino a l momento dell'arresto anomalo. Quando registri un NSError, l'app non viene terminata immediatamente. Poiché Crashlytics invia il report sugli errori registrati solo al successivo avvio dell'app e deve limitare la quantità di spazio allocato per i log sul disco, è possibile registrare una quantità sufficiente di log dopo la registrazione di un NSError in modo che tutti i log pertinenti vengano ruotati prima che Crashlytics invii il report 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. Al momento della chiamata, acquisisce lo stack di chiamate del thread corrente utilizzando un processo chiamato stack unwinding.Crashlytics Questo processo può richiedere un utilizzo intensivo di CPU e I/O, in particolare nelle architetture che supportano l'unwinding DWARF (arm64 e x86). Una volta completato l'unwinding, le informazioni vengono scritte sul disco in modo sincrono. In questo modo si evita la perdita di dati se la riga successiva dovesse arrestarsi in modo anomalo.

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

E per quanto riguarda NSExceptions?

Crashlytics non offre una funzionalità per la registrazione diretta delle istanze NSException. In generale, le API Cocoa e Cocoa Touch non sono sicure per le eccezioni. Ciò significa che l'utilizzo di @catch può avere effetti collaterali indesiderati molto gravi nel processo, anche se utilizzato con estrema attenzione. Non devi mai utilizzare le istruzioni @catch nel codice. Consulta la documentazione di Apple sull'argomento.

Personalizzare gli stack trace

Se la tua app viene eseguita in un ambiente non nativo (ad esempio C++ o Unity), puoi utilizzare l'API del modello di eccezione per segnalare i metadati sugli arresti anomali nel formato di eccezione nativo dell'app. Le eccezioni segnalate vengono 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 di 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];

Ottenere i log dei breadcrumb

I log dei breadcrumb ti consentono di comprendere meglio le interazioni che un utente ha avuto con la tua app prima di un evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utili quando cerchi di riprodurre ed eseguire il debug di un problema.

I log dei 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 dei breadcrumb vengono inclusi automaticamente nei dati di un evento nella scheda Log quando visualizzi i dettagli di un problema (vedi tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics dashboard della console Firebase).

L'Analytics SDK 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 compilati anche con tutti gli 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 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, inclusi i dati che compilano i log dei breadcrumb.

Attivare la segnalazione con consenso esplicito

Se attivi la segnalazione con consenso esplicito disattivando la segnalazione automatica, ridurrai l'accuratezza del conteggio degli eventi e delle metriche senza arresti anomali della tua app, che rifletteranno meno la stabilità complessiva dell'app. Scopri di più.

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app. Per dare agli utenti un maggiore controllo sui dati che inviano, puoi attivare la segnalazione con consenso esplicito disattivando la segnalazione automatica e inviando i dati a Crashlytics solo quando scegli di farlo nel codice.

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

   • Chiave: FirebaseCrashlyticsCollectionEnabled
   • Valore: false

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

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

   Se l'utente in un secondo momento disattiva la raccolta dei dati, puoi passare false come valore di override, che verrà applicato al successivo avvio dell'app e persisterà in tutti gli avvii successivi per l'utente.

Nota: quando la raccolta dei dati è disattivata per un utente, Crashlytics memorizzerà le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene attivata in un secondo momento, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.

Gestire i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando gli stack trace anonimizzati con quelli di altre app Firebase e comunicandoti 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 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 nella DevOps e coinvolgimento > Crashlytics dashboard della Firebase console.

Nota: la disattivazione della condivisione dei dati rimuove anche gli insight sui tuoi problemi. Le modifiche potrebbero richiedere fino a 24 ore prima di essere effettive.

Passaggi successivi

• Esporta i dati in BigQuery o Cloud Logging per analisi e funzionalità avanzate, come l'esecuzione di query sui dati, la creazione di dashboard personalizzate e la configurazione di avvisi personalizzati.