Personalizzare i report sugli arresti anomali per le piattaforme Apple

Puoi fare clic su un problema e visualizzare un report dettagliato sugli eventi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase. 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 offrono visibilità sulle azioni degli utenti che precedono un evento raccolto da Crashlytics nella tua app.

• Disattiva l'invio automatico dei report sugli arresti anomali e attiva l'invio dei report con 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 dashboard DevOps e coinvolgimento > Crashlytics della console Firebase.

• 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).

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

// Set int_key to 100.
Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set str_key to "hello".
Crashlytics.crashlytics().setCustomValue("hello", forKey: "str_key")

// 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 chiamandola e impostandola su un valore diverso. Ad esempio:

Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set int_key to 50 from 100.
Crashlytics.crashlytics().setCustomValue(50, forKey: "int_key")

[[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 collettivamente utilizzando il metodo setCustomKeysAndValues con un NSDictionary come unico parametro:

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)

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 un contesto più ampio degli 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 mostra nella scheda Log quando visualizzi i dettagli di un problema (visualizza tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase).

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

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

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

Imposta gli identificatori dell'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 gli ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore hash:

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

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

Se devi cancellare un identificatore dell'utente dopo averlo impostato, reimposta il valore su una stringa vuota. La cancellazione di un identificatore dell'utente non comporta la rimozione dei record Crashlytics esistenti. 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 della tua app, Crashlytics ti consente di registrare le eccezioni non irreversibili e te le invia al successivo avvio dell'app.

Puoi registrare eccezioni non fatali registrando gli oggetti NSError con il metodo recordError. recordError acquisisce lo stack di chiamate del thread chiamando [NSThread callStackReturnAddresses].

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

[[FIRCrashlytics crashlytics] recordError:error];

Quando utilizzi il metodo recordError, è importante comprendere la struttura di 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 indurre Crashlytics a limitare la generazione di report sugli 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 in base a domain e code. Questa è una distinzione importante tra arresti anomali irreversibili ed errori registrati. Ad esempio:

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)

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 riportato 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.

Log e chiavi personalizzate

Proprio 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 quelli allegati agli 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 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 un numero 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 i log e le chiavi personalizzate nella tua app.

Considerazioni sulle prestazioni

Tieni presente che il logging di un NSError può essere piuttosto costoso. Al momento della chiamata, Crashlytics acquisisce lo stack di chiamate del thread corrente utilizzando un processo chiamato stack unwinding. Questo processo può richiedere un utilizzo intensivo della CPU e dell'I/O, in particolare su architetture che supportano l'unwinding DWARF (arm64 e x86). Al termine dell'unwind, le informazioni vengono scritte sul disco in modo sincrono. In questo modo si evita 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 registrare e archiviare direttamente le 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 dovresti mai utilizzare istruzioni @catch nel codice. Consulta la 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 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.

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)

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 gli indirizzi:

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)

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 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 evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utili per riprodurre un problema ed eseguirne il debug.

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 (visualizza tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase).

L'SDK Analytics registra automaticamente l'evento screen_view, consentendo 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 inoltre compilati con tutti gli eventi personalizzati che registri 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 di 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 per tutti gli utenti della tua app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi attivare i report con attivazione disattivando i report automatici 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 utenti selezionati chiamando l'override della raccolta dei dati Crashlytics in fase di runtime. Il valore di override viene mantenuto in tutti i lanci 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 da parte dell'utente e persisterà in tutti gli avvii successivi per quell'utente.

Gestisci i dati di Crash Insights

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le tue analisi dello stack anonimizzate con quelle di altre app Firebase e informandoti se il tuo problema fa parte di una tendenza più ampia. Per molti problemi, gli insight sugli arresti anomali forniscono 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 dashboard DevOps e coinvolgimento > Crashlytics della console Firebase.

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.