Google is committed to advancing racial equity for Black communities. See how.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

Firebase Crashlytics può funzionare con una configurazione minima da parte tua. Non appena aggiungi l'SDK, Crashlytics si mette al lavoro inviando rapporti sugli arresti anomali alla console Firebase .

Per darti maggiori informazioni sui rapporti sugli arresti anomali, Firebase Crashlytics fornisce quattro meccanismi di registrazione immediatamente disponibili: chiavi personalizzate , registri personalizzati , identificatori utente ed eccezioni rilevate .

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app fino a un arresto anomalo. Puoi associare coppie chiave / valore arbitrarie ai rapporti sugli arresti anomali e visualizzarli nella console di Firebase .

Inizia con [CrashlyticsKit setObjectValue:forKey:] o uno dei metodi correlati:

- (void)setObjectValue:(id)value forKey:(NSString *)key;

// calls -description on value, perfect for NSStrings!
- (void)setIntValue:(int)value forKey:(NSString *)key;

- (void)setBoolValue:(BOOL)value forKey:(NSString *)key;

- (void)setFloatValue:(float)value forKey:(NSString *)key;

A volte è necessario modificare il valore della chiave esistente. Chiama la stessa chiave, ma sostituisci il valore, ad esempio:

Obiettivo-C
[CrashlyticsKit setIntValue:3 forKey:@"current_level"];
[CrashlyticsKit setObjectValue:@"logged_in" forKey:@"last_UI_action"];
Swift
Crashlytics.sharedInstance().setIntValue(42, forKey: "MeaningOfLife")
Crashlytics.sharedInstance().setObjectValue("Test value", forKey: "last_UI_action")

Aggiungi messaggi di registro personalizzati

Per darti più contesto per gli eventi che portano a un arresto anomalo, puoi aggiungere registri Crashlytics personalizzati alla tua app. Crashlytics associa i log ai dati sugli arresti anomali e li rende visibili nella console di Firebase .

Obiettivo-C

In Objective-C, usa CLS_LOG per individuare i problemi. Include automaticamente informazioni sulla classe, sul metodo e sul numero di riga Objective-C associati al registro.

CLS_LOG comportamento di CLS_LOG cambia a seconda che si CLS_LOG registrando per un debug o una build di rilascio:

  • Build di debug: CLS_LOG passa a NSLog modo da poter vedere l'output in Xcode e sul dispositivo o simulatore.
  • Build di rilascio: per migliorare le prestazioni, CLS_LOG silenzia tutti gli altri output e non passa attraverso NSLog .

Utilizzare CLS_LOG(format, ...) per accedere con CLS_LOG . Per esempio:

CLS_LOG(@"Higgs-Boson detected! Bailing out... %@", attributesDict);

Sfoglia il file di intestazione Crashlytics/Crashlytics.h per maggiori dettagli su come utilizzare CLS_LOG .

Swift

In Swift, usa CLSLogv o CLSNSLogv per individuare i problemi.

Ci sono due cose da tenere a mente quando si accede con CLSLogv e CLSNSLogv :

  • L'argomento del formato deve essere una stringa costante in fase di compilazione. Questo è applicato dal compilatore in Objective-C, ma quella protezione è attualmente persa nel bridging a Swift.
  • Memorizza i valori di registro in un array e chiama getVaList su quell'array per recuperarli.

Per esempio:

func write(string: String) {
    CLSLogv("%@", getVaList([string]))
}
L'interpolazione rapida delle stringhe non darà come risultato una stringa costante in fase di compilazione. Proprio come con printf e NSLog, l'utilizzo di una stringa non costante con CLSLog può provocare un arresto anomalo.

Avanzate

Per un maggiore controllo, puoi sfruttare direttamente CLSLog(format, ...) e CLSNSLog(format, ...) . Quest'ultimo passa a NSLog modo da poter vedere l'output in Xcode o sul dispositivo o simulatore. CLSLog(format, ...) e CLSNSLog(format, ...) sono thread-safe. CLSLog serve per registrare informazioni importanti per la risoluzione di arresti anomali. Non dovrebbe essere utilizzato per tenere traccia degli eventi in-app.

Imposta 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 rapporti sugli arresti anomali.

Per aggiungere ID utente ai tuoi rapporti, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore con hash:

Obiettivo-C
[CrashlyticsKit setUserIdentifier:@"123456789"];
Swift
Crashlytics.sharedInstance().setUserIdentifier("123456789")

Se è 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 .

Registra eccezioni non irreversibili

Oltre a segnalare automaticamente gli arresti anomali della tua app, Crashlytics ti consente di registrare eccezioni non irreversibili.

Su iOS, lo fai registrando oggetti NSError , che Crashlytics riporta e raggruppa in modo molto simile agli arresti anomali:

Obiettivo-C
[CrashlyticsKit recordError:error];
Swift
Crashlytics.sharedInstance().recordError(error)

Quando si utilizza 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 non corretto del metodo recordError può causare comportamenti imprevedibili e potrebbe richiedere a Crashlytics di limitare la segnalazione degli errori registrati per la tua app.

Un oggetto NSError ha tre argomenti: domain: String , code: Int e userInfo: [AnyHashable : Any]? = nil

A differenza degli arresti anomali irreversibili, raggruppati tramite l'analisi dello stack trace, gli errori registrati vengono raggruppati in base al domain e al code NSError. Questa è un'importante distinzione tra arresti anomali irreversibili ed errori registrati. Ad esempio, la registrazione di un errore come:

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";
    UserID: @"Jane Smith"
};

NSError *error = [NSError domain:NSSomeErrorDomain
                          code:-1001
                          userInfo:userInfo];

Crea un nuovo problema raggruppato per NSSomeErrorDomain e -1001 . Ulteriori errori registrati che utilizzano lo stesso dominio e valori di codice verranno raggruppati in questo problema.

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 un'elevata cardinalità dei problemi e potrebbe far sì che Crashlytics debba limitare la segnalazione degli errori registrati nella tua app. I valori univoci dovrebbero invece essere aggiunti all'oggetto dizionario userInfo.

I dati contenuti nell'oggetto userInfo vengono convertiti in coppie chiave-valore e visualizzati nella sezione chiavi / registri all'interno di un singolo problema.

Crashlytics memorizza solo le 8 eccezioni più recenti in una determinata sessione dell'app. Se la tua app genera più di 8 eccezioni in una sessione, le eccezioni meno recenti vengono perse.

Log e chiavi personalizzate

Proprio come i rapporti 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. Quando si registra un NSError, l'app non si chiude immediatamente. Poiché Crashlytics invia il rapporto di errore registrato solo al successivo avvio dell'app e poiché Crashlytics deve limitare la quantità di spazio allocato per i registri su disco, è possibile registrare abbastanza dopo che un NSError è stato registrato in modo che tutti i registri rilevanti vengano ruotati dal ora Crashlytics invia il rapporto dal dispositivo. Tieni presente questo equilibrio quando accedi a NSErrors e utilizzi CLSLog e le chiavi personalizzate nella tua app.

Considerazioni sulle prestazioni

Tieni presente che registrare un NSError può essere piuttosto costoso. Nel momento in cui effettui la chiamata, Crashlytics acquisisce lo stack di chiamate del thread corrente utilizzando un processo chiamato svolgimento dello stack. Questo processo può richiedere un uso intensivo della CPU e dell'I / O, in particolare su architetture che supportano lo svolgimento DWARF (arm64 e x86). Al termine dello svolgimento, le informazioni vengono scritte sul disco in modo sincrono. Ciò impedisce la perdita di dati se la riga successiva dovesse bloccarsi.

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

E per quanto riguarda NSExceptions?

Crashlytics non offre una funzione per la registrazione / registrazione diretta delle istanze di NSException. In generale, le API Cocoa e Cocoa Touch non sono sicure dalle eccezioni. Ciò significa che l'uso di @catch può avere effetti collaterali indesiderati molto gravi nel processo, anche se usato con estrema cura. Non dovresti mai usare istruzioni @catch nel tuo codice. Fare riferimento alla documentazione di Apple sull'argomento.

Abilita i rapporti sull'attivazione

Per impostazione predefinita, Firebase Crashlytics raccoglie automaticamente i rapporti sugli arresti anomali per tutti gli utenti della tua app. Per dare agli utenti un maggiore controllo sui dati che inviano, puoi invece abilitare i rapporti di attivazione.

Per fare ciò, devi disabilitare la raccolta automatica e inizializzare Crashlytics solo per gli utenti che effettuano l'autorizzazione.

  1. Disattiva la raccolta automatica con una nuova chiave per il tuo file Info.plist :
    • Chiave: firebase_crashlytics_collection_enabled
    • Valore: false
  2. Abilita la raccolta per utenti selezionati inizializzando Crashlytics in fase di esecuzione:
    Obiettivo-C
    [Fabric with:@[[Crashlytics class]]];
    Swift
    Fabric.with([Crashlytics.self])

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 di stabilità comuni. 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 .