Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Personalize seus relatórios de falhas do Firebase Crashlytics

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Este guia descreve como personalizar seus relatórios de falhas usando o SDK do Firebase Crashlytics. Por padrão, o Crashlytics coleta automaticamente relatórios de falhas para todos os usuários do seu aplicativo (você pode desativar os relatórios automáticos de falhas e ativar os relatórios de ativação para seus usuários). O Crashlytics fornece quatro mecanismos de log prontos para uso: chaves personalizadas , logs personalizados , identificadores de usuário e exceções capturadas .

Adicionar chaves personalizadas

As chaves personalizadas ajudam você a obter o estado específico do seu aplicativo que leva a uma falha. Você pode associar pares de chave/valor arbitrários aos seus relatórios de falhas e usar as chaves personalizadas para pesquisar e filtrar relatórios de falhas no Firebase console.

  • No painel do Crashlytics , você pode pesquisar problemas que correspondam a uma chave personalizada.
  • Ao analisar um problema específico no console, você pode visualizar as chaves personalizadas associadas a cada evento (subguia Chaves ) e até filtrar os eventos por chaves personalizadas (menu Filtro na parte superior da página).

Use o método setCustomValue para definir pares de chave/valor. Por exemplo:

Rápido

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

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

Objetivo-C

Ao definir números inteiros, booleanos ou flutuantes, marque o valor como @( 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"];

Você também pode modificar o valor de uma chave existente chamando a chave e definindo-a com um valor diferente. Por exemplo:

Rápido

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

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

Objetivo-C

[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set int_key to 50 from 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(50) forKey:@"int_key"];

Adicione pares de chave/valor em massa usando o método setCustomKeysAndValues ​​com um NSDictionary como o único parâmetro:

Rápido

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)

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

Adicionar mensagens de registro personalizadas

Para obter mais contexto para os eventos que levaram a uma falha, você pode adicionar logs personalizados do Crashlytics ao seu aplicativo. O Crashlytics associa os registros aos seus dados de falha e os exibe na página Crashlytics do console do Firebase , na guia Registros .

Rápido

Use log() ou log(format:, arguments:) para ajudar a identificar problemas. Se você deseja obter uma saída de log útil com mensagens, o objeto que você passa para log() deve estar em conformidade com a propriedade CustomStringConvertible . log() retorna a propriedade de descrição que você define para o objeto. Por exemplo:

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

.log(format:, arguments:) formata valores retornados ao chamar getVaList() . Por exemplo:

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

Para obter mais detalhes sobre como usar log() ou log(format:, arguments:) , consulte a documentação de referência do Crashlytics.

Objetivo-C

Use log ou logWithFormat para ajudar a identificar problemas. Observe que, se você deseja obter uma saída de log útil com mensagens, o objeto que você passa para qualquer um dos métodos deve substituir a propriedade de instância de description . Por exemplo:

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

Para obter mais detalhes sobre como usar log e logWithFormat , consulte a documentação de referência do Crashlytics.

Definir identificadores de usuário

Para diagnosticar um problema, geralmente é útil saber quais usuários sofreram uma determinada falha. O Crashlytics inclui uma maneira de identificar usuários anonimamente em seus relatórios de falhas.

Para adicionar IDs de usuário a seus relatórios, atribua a cada usuário um identificador exclusivo na forma de um número de ID, token ou valor com hash:

Rápido

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

Objetivo-C

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

Se você precisar limpar um identificador de usuário depois de defini-lo, redefina o valor para uma string em branco. A limpeza de um identificador de usuário não remove os registros existentes do Crashlytics. Se você precisar excluir registros associados a um ID de usuário, entre em contato com o suporte do Firebase .

Relatar exceções não fatais

Além de relatar automaticamente as falhas do seu aplicativo, o Crashlytics permite que você registre exceções não fatais e as envie para você na próxima vez que seu aplicativo for iniciado.

Você pode gravar exceções não fatais gravando objetos NSError com o método recordError . recordError captura a pilha de chamadas do thread chamando [NSThread callStackReturnAddresses] .

Rápido

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

Objetivo-C

[[FIRCrashlytics crashlytics] recordError:error];

Ao usar o método recordError , é importante entender a estrutura NSError e como o Crashlytics usa os dados para agrupar falhas. O uso incorreto do método recordError pode causar um comportamento imprevisível e fazer com que o Crashlytics limite o relatório de erros registrados para seu aplicativo.

Um objeto NSError tem três argumentos:

  • domain: String
  • code: Int
  • userInfo: [AnyHashable : Any]? = nil

Ao contrário das falhas fatais, que são agrupadas por meio da análise de rastreamento de pilha, os erros registrados são agrupados por domain e code . Esta é uma distinção importante entre falhas fatais e erros registrados. Por exemplo:

Rápido

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)

Objetivo-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 você registra o erro acima, ele cria um novo problema agrupado por NSSomeErrorDomain e -1001 . Erros registrados adicionais que usam o mesmo domínio e valores de código são agrupados sob o mesmo problema. Os dados contidos no objeto userInfo são convertidos em pares de valores-chave e exibidos na seção de chaves/logs em um problema individual.

Logs e chaves personalizadas

Assim como os relatórios de falhas, você pode incorporar logs e chaves personalizadas para adicionar contexto ao NSError . No entanto, há uma diferença em quais logs são anexados a falhas versus erros registrados. Quando ocorre uma falha e o aplicativo é reiniciado, os logs que o Crashlytics recupera do disco são aqueles que foram gravados até o momento da falha. Quando você registra um NSError , o aplicativo não é encerrado imediatamente. Como o Crashlytics envia apenas o relatório de erro registrado na próxima inicialização do aplicativo e deve limitar a quantidade de espaço alocado para logs no disco, é possível registrar o suficiente após um NSError ser registrado para que todos os logs relevantes sejam alternados no momento em que o Crashlytics enviar o relatório do dispositivo. Lembre-se desse equilíbrio ao registrar NSErrors e usar logs e chaves personalizadas em seu aplicativo.

Considerações de desempenho

Tenha em mente que registrar um NSError pode ser bastante caro. No momento em que você faz a chamada, o Crashlytics captura a pilha de chamadas do thread atual usando um processo chamado desenrolamento de pilha. Esse processo pode ser intensivo em CPU e E/S, principalmente em arquiteturas que suportam desenrolamento DWARF (arm64 e x86). Após a conclusão do desenrolamento, as informações são gravadas no disco de forma síncrona. Isso evita a perda de dados se a próxima linha falhar.

Embora seja seguro chamar essa API em um thread em segundo plano, lembre-se de que despachar essa chamada para outra fila perde o contexto do rastreamento de pilha atual.

E as NSExceptions?

O Crashlytics não oferece um recurso para registrar e registrar instâncias NSException diretamente. De um modo geral, as APIs Cocoa e Cocoa Touch não são seguras para exceções. Isso significa que o uso de @catch pode ter efeitos colaterais não intencionais muito sérios em seu processo, mesmo quando usado com extremo cuidado. Você nunca deve usar instruções @catch em seu código. Consulte a documentação da Apple sobre o assunto.

Ativar relatórios de aceitação

Por padrão, o Crashlytics coleta automaticamente relatórios de falhas para todos os usuários do seu aplicativo. Para dar aos usuários mais controle sobre os dados que eles enviam, você pode ativar os relatórios de aceitação desativando os relatórios automáticos e enviando dados para o Crashlytics apenas quando você escolher em seu código:

  1. Desative a coleta automática adicionando uma nova chave ao seu arquivo Info.plist :

    • Chave: FirebaseCrashlyticsCollectionEnabled
    • Valor: false
  2. Habilite a coleta para usuários selecionados chamando a substituição de coleta de dados do Crashlytics no tempo de execução. O valor de substituição persiste nas inicializações do seu aplicativo para que o Crashlytics possa coletar relatórios automaticamente.

    Para desativar o relatório automático de falhas, passe false como o valor de substituição. Quando definido como false , o novo valor não se aplica até a próxima execução do aplicativo.

    Rápido

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Objetivo-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Gerenciar dados do Crash Insights

O Crash Insights ajuda a resolver problemas comparando seus rastreamentos de pilha anônimos com rastreamentos de outros aplicativos do Firebase e informando se o problema faz parte de uma tendência maior. Para muitos problemas, o Crash Insights ainda fornece recursos para ajudá-lo a depurar a falha.

O Crash Insights usa dados de falhas agregados para identificar tendências comuns de estabilidade. Se preferir não compartilhar os dados do seu aplicativo, desative o Crash Insights no menu Crash Insights na parte superior da lista de problemas do Crashlytics no console do Firebase .