This guide contains instructions for the latest version of the Firebase Crashlytics SDK. If you migrated your app from Fabric, make sure it's been upgraded and no longer uses the deprecated legacy Fabric SDK.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

Questa guida descrive come personalizzare i rapporti sugli arresti anomali utilizzando Firebase Crashlytics SDK. Per impostazione predefinita, Crashlytics raccoglie automaticamente i rapporti sugli arresti anomali per tutti gli utenti della tua app (puoi disattivare i rapporti automatici sugli arresti anomali e abilitare i rapporti di attivazione per i tuoi utenti). Crashlytics fornisce quattro meccanismi di registrazione pronti all'uso: chiavi personalizzate , log personalizzati , identificatori utente ed eccezioni rilevate .

Aggiungi chiavi personalizzate

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

Utilizza il metodo setCustomValue per impostare le coppie chiave / valore. Per 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")

Obiettivo-C

Quando si impostano numeri interi, booleani o float, box 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"];

È inoltre possibile modificare il valore di una chiave esistente chiamando la chiave e impostandola su un valore diverso. Per esempio:

Swift

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 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 visualizza nella pagina Crashlytics della console di Firebase , nella scheda Log .

Swift

Usa log() o log(format:, arguments:) per individuare i problemi. Se si desidera ottenere un utile output di log con i messaggi, l'oggetto che si passa a log() deve essere conforme alla proprietà CustomStringConvertible . log() restituisce la proprietà di descrizione definita per l'oggetto. Per esempio:

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

.log(format:, arguments:) formatta i valori restituiti dalla chiamata a getVaList() . Per esempio:

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

Per maggiori dettagli su come utilizzare log() o log(format:, arguments:) , fare riferimento alla documentazione di riferimento delle funzioni di Crashlytics.

Obiettivo-C

Usa log o logWithFormat per individuare i problemi. Si noti che se si desidera ottenere un utile output di log con i messaggi, l'oggetto che si passa a uno dei metodi deve sovrascrivere la proprietà dell'istanza di 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 delle funzioni di Crashlytics.

Imposta 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 ogni utente un identificatore univoco sotto forma di numero ID, token o valore con hash:

Swift
Crashlytics.crashlytics().setUserID("123456789")
Obiettivo-C
[[FIRCrashlytics crashlytics] setUserID:@"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 .

Segnala eccezioni non irreversibili

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

Swift

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

Obiettivo-C

[[FIRCrashlytics crashlytics] 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 un comportamento imprevedibile e può 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, raggruppati tramite l'analisi dello stack trace, gli errori registrati sono raggruppati per domain e code . Questa è un'importante distinzione tra arresti anomali irreversibili ed errori registrati. Per 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)

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 si registra l'errore precedente, viene creato un nuovo problema raggruppato per NSSomeErrorDomain e -1001 . Ulteriori errori registrati che utilizzano lo stesso dominio e 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 / registri all'interno di un singolo problema.

Avviso: 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 .

Log e chiavi personalizzate

Proprio come i rapporti sugli NSError , 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 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 prima dell'invio di Crashlytics il report dal dispositivo. Tieni presente questo equilibrio quando accedi a NSErrors e utilizzi log e 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 stack unwinding. 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 perde il contesto dell'analisi dello stack corrente.

E per quanto riguarda NSExceptions?

Crashlytics non offre una funzione per la registrazione e la registrazione NSException 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 cautela. Non dovresti mai usare @catch istruzioni @catch nel tuo codice. Fare riferimento alla documentazione di Apple sull'argomento.

Personalizza le tracce dello stack

Se la tua app viene eseguita in un ambiente non nativo (come C ++ o Unity), puoi usare 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 irreversibili.

Swift

var  ex = ExceptionModel.init(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame.init(symbol:"makeError" fileName:"handler.js" lineNumber:495),
  StackFrame.init(symbol:"then" fileName:"routes.js" lineNumber:102),
  StackFrame.init(symbol:"main" fileName:"app.js" lineNumber:12),
]

crashlytics.record(exceptionModel:ex)

Obiettivo-C

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithSymbol:@"makeError" fileName:@"handler.js" lineNumber:495],
  [FIRStackFrame stackFrameWithSymbol:@"then" fileName:@"routes.js" lineNumber:102],
  [FIRStackFrame stackFrameWithSymbol:@"main" fileName:@"app.js" lineNumber:12],
];

Abilita i rapporti sull'attivazione

Per impostazione predefinita, 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 abilitare i rapporti di attivazione per i tuoi utenti disabilitando la raccolta automatica e inizializzando Crashlytics solo per gli utenti selezionati:

  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 sostituzione persiste durante i lanci della tua app in modo che Crashlytics possa raccogliere automaticamente i rapporti. 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.

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