Entender as falhas de um jogo do Unity usando os recursos avançados do Crashlytics

1. Introdução

Neste codelab, você vai aprender a usar recursos avançados do Crashlytics, que oferecem uma melhor visibilidade das falhas e das circunstâncias que podem ter causado isso.

Você adicionará novas funcionalidades a um jogo de amostra, MechaHamster: suba de nível com o Firebase Edition. Este jogo de exemplo é uma nova versão do MechaHamster clássico do Firebase que remove a maior parte das funcionalidades integradas do Firebase, oferecendo a você a chance de implementar novos usos da plataforma.

Você adicionará um menu de depuração ao jogo. Esse menu de depuração chama os métodos que você criará e permite usar as diferentes funcionalidades do Crashlytics. Esses métodos mostram como anotar relatórios automáticos de erros com chaves personalizadas, registros personalizados, erros não fatais e muito mais.

Depois de criar o jogo, você vai usar o menu de depuração e inspecionar os resultados para entender a visão única que eles oferecem de como seu jogo é executado normalmente.

Conteúdo

• Os tipos de erros que são detectados automaticamente pelo Crashlytics.
• Erros adicionais que podem ser registrados propositalmente.
• Como adicionar mais informações a esses erros para facilitar a compreensão.

Pré-requisitos

• Unity (versão mínima recomendada 2019 ou mais recente) com um ou ambos os itens a seguir:
  • Suporte ao build do iOS
  • Suporte ao build do Android
• (Somente para Android) A CLI do Firebase (usada para fazer upload de símbolos para relatórios de erros)
  • Siga as instruções para instalar a CLI do Firebase.
    Se você já instalou a CLI, atualize para a versão mais recente.

2. Configurar o ambiente de desenvolvimento

As seções a seguir descrevem como fazer o download do código Avanço de nível com o Firebase e abri-lo no Unity.

O jogo de exemplo Passar de fase com o Firebase é usado por vários outros codelabs do Firebase e do Unity, então talvez você já tenha concluído as tarefas desta seção. Nesse caso, vá diretamente para a última etapa desta página: "Adicionar SDKs do Firebase para Unity".

Fazer o download do código

Clone o repositório do GitHub deste codelab na linha de comando:

git clone https://github.com/firebase/level-up-with-firebase.git

Se você não tiver o git instalado, faça o download do repositório como um arquivo ZIP (link em inglês).

Abra Avance de nível com o Firebase no editor do Unity.

1. Inicie o Unity Hub e, na guia Projects, clique na seta suspensa ao lado de Open.
2. Clique em Adicionar projeto do disco.
3. Navegue até o diretório que contém o código e clique em OK.
4. Se solicitado, selecione uma versão do editor do Unity e a plataforma de destino (Android ou iOS).
5. Clique no nome do projeto, level-up-with-firebase, para abrir o projeto no editor do Unity.
6. Caso seu editor não abra o arquivo automaticamente, abra MainGameScene em Assets > Hamster na guia Project do Unity Editor.
   

Para mais informações sobre como instalar e usar o Unity, consulte Como trabalhar no Unity.

3. Adicionar o Firebase ao seu projeto do Unity

criar um projeto do Firebase

1. No Console do Firebase, clique em Adicionar projeto.
2. Para criar um novo projeto, digite o nome dele.
   Isso também definirá o ID do projeto (exibido abaixo do nome do projeto) como algo baseado no nome dele. Clique no ícone de edição no ID do projeto para personalizá-lo ainda mais.
3. Se solicitado, leia e aceite os Termos do Firebase.
4. Clique em Continuar.
5. Selecione a opção Ativar o Google Analytics para este projeto e clique em Continuar.
6. Selecione uma conta existente do Google Analytics para usar ou selecione Criar uma nova conta.
7. Clique em Criar projeto.
8. Quando o projeto for criado, clique em Continuar.

Registrar o app no Firebase

1. Ainda no Console do Firebase, no centro da página de visão geral do projeto, clique no ícone do Unity para iniciar o fluxo de trabalho de configuração ou, se você já tiver adicionado um app ao projeto do Firebase, clique em Adicionar app para exibir as opções da plataforma.
2. Selecione para registrar os destinos de build para Apple (iOS) e Android.
3. Insira os IDs específicos da plataforma do seu projeto do Unity. Para este codelab, digite o seguinte:
   • Para Apple (iOS): insira com.google.firebase.level-up no campo ID do pacote do iOS.
   • For Android: digite com.google.firebase.level_up no campo Android package name.

   Importante: o ID do pacote iOS e o nome do pacote Android acima são diferentes. O identificador iOS é inválido para Android e vice-versa. Verifique se você está usando o identificador correto.

4. (Opcional) Insira os apelidos específicos da plataforma do seu projeto do Unity.
5. Clique em Registrar app e prossiga para a seção Fazer o download do arquivo de configuração.

Adicionar arquivos de configuração do Firebase

Depois de clicar em Registrar app, será feito o download de dois arquivos de configuração (um arquivo de configuração para cada destino de compilação). Seu projeto do Unity precisa dos metadados do Firebase nesses arquivos para se conectar ao Firebase.

1. Faça download dos dois arquivos de configuração disponíveis:
   • Para Apple (iOS): faça o download de GoogleService-Info.plist.
   • Para Android: faça o download do google-services.json.
2. Abra a janela Project do projeto do Unity e mova os dois arquivos de configuração para a pasta Assets.

   Importante:mesmo que você pretenda criar apenas o iOS ou o Android, faça o download dos dois arquivos e adicione-os ao projeto.

3. De volta ao fluxo de trabalho de configuração no Console do Firebase, clique em Próxima e selecione "Adicionar SDKs do Firebase para Unity".

Observação:para fazer o download desses arquivos de novo depois, abra as configurações gerais do seu projeto, role para baixo até a seção Seus apps e clique no botão de download do arquivo de configuração desejado.

Adicionar SDKs do Firebase para Unity

1. Clique em Fazer o download do SDK do Firebase para Unity no Console do Firebase.

   Observação:o download desse SDK pode demorar um pouco. Tomeem um café ou um chá e mantenham-se hidratados, meus amigos.

2. Descompacte o SDK em um local prático.
3. No seu projeto aberto do Unity, acesse Assets > Import Package > Custom Package.
4. Na caixa de diálogo Import package, navegue até o diretório que contém o SDK descompactado, selecione FirebaseAnalytics.unitypackage e clique em Open.
5. Na caixa de diálogo Import Unity Package exibida, clique em Import.
6. Repita as etapas anteriores para importar FirebaseCrashlytics.unitypackage.
7. Retorne ao Console do Firebase e, no fluxo de trabalho de configuração, clique em Próxima.

Para mais informações sobre como adicionar SDKs do Firebase a projetos do Unity, consulte Outras opções de instalação do Unity.

4. Configurar o Crashlytics no seu projeto do Unity

Para usar o Crashlytics em projetos do Unity, você precisa seguir mais algumas etapas de configuração. Obviamente, você vai precisar inicializar o SDK. Porém, também será necessário fazer upload dos símbolos para poder ver stack traces simbólicos no Console do Firebase. Além disso, você terá que forçar uma falha no teste para garantir que o Firebase receba os eventos de falha.

Inicializar o SDK do Crashlytics

1. Em Assets/Hamster/Scripts/MainGame.cs, adicione as seguintes instruções using:

   using Firebase.Crashlytics;
   using Firebase.Extensions;
   

   O primeiro módulo permite usar métodos do SDK do Crashlytics e o segundo contém algumas extensões para a API C# Tasks. Sem as duas instruções using, o código a seguir não vai funcionar.
2. Ainda no MainGame.cs, adicione a inicialização do Firebase ao método Start() existente chamando InitializeFirebaseAndStartGame():

   void Start()
   {
     Screen.SetResolution(Screen.width / 2, Screen.height / 2, true);
     InitializeFirebaseAndStartGame();
   }
   

3. E novamente, em MainGame.cs, encontre InitializeFirebaseAndStartGame(), declare uma variável de app e substitua a implementação do método desta forma:

   public Firebase.FirebaseApp app = null;
   
   // Begins the firebase initialization process and afterwards, opens the main menu.
   private void InitializeFirebaseAndStartGame()
   {
     Firebase.FirebaseApp.CheckAndFixDependenciesAsync()
     .ContinueWithOnMainThread(
       previousTask => 
       {
         var dependencyStatus = previousTask.Result;
         if (dependencyStatus == Firebase.DependencyStatus.Available) {
           // Create and hold a reference to your FirebaseApp,
           app = Firebase.FirebaseApp.DefaultInstance;
           // Set the recommended Crashlytics uncaught exception behavior.
           Crashlytics.ReportUncaughtExceptionsAsFatal = true;
           InitializeCommonDataAndStartGame();
         } else {
           UnityEngine.Debug.LogError(
             $"Could not resolve all Firebase dependencies: {dependencyStatus}\n" +
             "Firebase Unity SDK is not safe to use here");
         }
       });
   }
   

Colocar a lógica de inicialização aqui impede a interação do jogador antes que as dependências do Firebase sejam inicializadas.

Os benefícios e efeitos de relatar exceções não processadas como fatais são discutidos nas Perguntas frequentes do Crashlytics.

Criar seu projeto e fazer upload de símbolos

Observação:conclua as etapas nesta seção para configurar o Crashlytics. No futuro, conclua essas etapas sempre que você criar um build de lançamento ou qualquer build para o qual você queira ver stack traces simbolizados no Console do Firebase (neste codelab, após cada etapa).

As etapas para criar e fazer upload de símbolos são diferentes para apps iOS e Android.

iOS+ (plataforma Apple)

1. Na caixa de diálogo Build Settings, exporte seu projeto para um espaço de trabalho do Xcode.
2. Crie seu app.
   Para plataformas da Apple, o plug-in do Editor do Firebase para Unity configura automaticamente seu projeto do Xcode para gerar e fazer upload de um arquivo de símbolos compatível com o Crashlytics para os servidores do Firebase em cada build. Essas informações de símbolos são necessárias para exibir stack traces simbolizados no painel do Crashlytics.

Android

1. (apenas durante a configuração inicial, não para cada build) Configure seu build:
   1. Crie uma nova pasta chamada Builds na raiz do diretório do projeto (ou seja, como um irmão do diretório Assets) e depois crie uma subpasta chamada Android.
   2. Em File > Build Settings > Player Settings > Configuration, defina o Scripting Backend como IL2CPP.
      • O IL2CPP geralmente faz com que os builds sejam menores e tenham melhor desempenho.
      • O IL2CPP também é a ÚNICA opção disponível no iOS e selecioná-lo aqui permite que as duas plataformas fiquem em melhor paridade e simplifiquem as diferenças de depuração entre as duas (se você optar por compilar ambas).
2. Crie seu app. Em File > Build Settings, faça o seguinte:
   1. Confira se a opção Criar símbolos.zip está marcada ou, se um menu suspenso aparecer, selecione Depuração.
   2. Crie seu APK diretamente do Unity Editor na subpasta Builds/Android que você acabou de criar.
3. Quando seu build terminar, você precisará gerar um arquivo de símbolo compatível com o Crashlytics e fazer upload dele para os servidores do Firebase. Essas informações de símbolos são necessárias para exibir stack traces simbolizados para falhas da biblioteca nativa no painel do Crashlytics.
   
   Gere e faça upload desse arquivo de símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

   • FIREBASE_APP_ID: o ID do app Android do Firebase (não o nome do pacote). Encontre esse valor no arquivo google-services.json que você baixou anteriormente. É o valor mobilesdk_app_id.
     Exemplo de ID do app Android do Firebase: 1:567383003300:android:17104a2ced0c9b9b
   • PATH/TO/SYMBOLS: o caminho do arquivo de símbolo compactado gerado no diretório Builds/Android quando o build foi concluído (por exemplo: Builds/Android/myapp-1.0-v100.symbols.zip).

     Observação:o nome desse arquivo vai mudar quando o projeto for criado com números diferentes definidos para Version e Bundle Version Code em File > Build Settings > Player Settings > Identification.

Forçar uma falha de teste para concluir a configuração

Para concluir a configuração do Crashlytics e ver os dados iniciais no painel do Console do Firebase, é necessário forçar uma falha no teste.

1. Em MainGameScene, encontre o EmptyObjectGameObject na seção Hierarchy do editor, adicione o script a seguir a ele e salve a cena. Esse script vai causar uma falha no teste alguns segundos depois da execução do app.

   using System;
   using UnityEngine;
   
   public class CrashlyticsTester : MonoBehaviour {
       // Update is called once per frame
       void Update()
       {
           // Tests your Crashlytics implementation by
           // throwing an exception every 60 frames.
           // You should see reports in the Firebase console
           // a few minutes after running your app with this method.
           if(Time.frameCount >0 && (Time.frameCount%60) == 0)
           {
               throw new System.Exception("Test exception; please ignore");
           }
       }
   }
   

2. Crie seu aplicativo e, em seguida, faça upload das informações de símbolo.
   • iOS: o plug-in do Editor do Firebase para Unity configura automaticamente seu projeto do Xcode para fazer upload do arquivo de símbolo.
   • Android: execute o comando crashlytics:symbols:upload da CLI do Firebase para fazer upload do arquivo de símbolo.

   Observação: se esta for a primeira vez que você está criando para um destino específico para dispositivos móveis, o tempo de compilação pode ser de vários minutos. Os builds subsequentes serão muito mais rápidos.

3. Execute o app. Quando ele estiver em execução, observe o registro do dispositivo e aguarde a exceção ser acionada da CrashlyticsTester.
   • iOS: veja os registros no painel inferior do Xcode.
   • Android: confira os registros executando o comando adb logcat no terminal.
4. Acesse o painel do Crashlytics para conferir essa exceção. Ele aparece na tabela Problemas na parte de baixo do painel. Mais adiante no codelab, você vai aprender a analisar esses relatórios.
5. Depois de confirmar que o evento foi enviado para o Crashlytics, selecione o EmptyObject GameObject a que ele foi anexado, remova apenas o componente CrashlyticsTester e salve a cena para restaurá-la à condição original.

5. Ativar e entender o menu de depuração

Até agora, você adicionou o Crashlytics ao seu projeto do Unity, concluiu a configuração e confirmou que o SDK do Crashlytics está fazendo upload de eventos para o Firebase. Agora você vai criar um menu no seu projeto do Unity que vai demonstrar como usar uma funcionalidade mais avançada do Crashlytics no seu jogo. O projeto do Unity para avançar de nível com o Firebase já tem um menu de depuração oculto que ficará visível e será usado para programar.

Ativar o menu de depuração

O botão para acessar o menu de depuração existe no seu projeto do Unity, mas não está ativado no momento. É preciso ativar o botão para acessá-lo do prefab MainMenu:

1. No Editor do Unity, abra o prefab chamado MainMenu.
2. Na hierarquia do prefab, encontre e selecione o subobjeto desativado chamado DebugMenuButton.
3. Para ativar a DebugMenuButton, marque a caixa no canto superior esquerdo à esquerda do campo de texto que contém DebugMenuButton.
4. Salve o prefab.
5. Execute o jogo no editor ou no dispositivo. O menu deve estar acessível agora.

Importante: como os métodos de falha não estão implementados no momento, tocar nos respectivos botões vai gerar uma System.NotImplementedException e não fará nada.

Visualizar e entender os corpos dos métodos do menu "Debug"

Mais adiante neste codelab, você vai criar corpos de métodos para alguns métodos de depuração do Crashlytics pré-configurados. No entanto, no projeto avançar de nível com o Firebase do Unity, os métodos são definidos e chamados no DebugMenu.cs.

Embora alguns deles chamem métodos do Crashlytics e gerem erros, a capacidade do Crashlytics de detectar esses erros não depende de chamar esses métodos primeiro. Em vez disso, os relatórios de erros gerados com a detecção automática de erros serão aprimorados pelas informações adicionadas por esses métodos.

Abra DebugMenu.cs e localize os seguintes métodos:

Métodos para gerar e anotar problemas do Crashlytics:

• CrashNow
• LogNonfatalError
• LogStringsAndCrashNow
• SetAndOverwriteCustomKeyThenCrash
• SetLogsAndKeysBeforeANR

Métodos para registrar eventos do Analytics e ajudar na depuração:

• LogProgressEventWithStringLiterals
• LogIntScoreWithBuiltInEventAndParams

Nas próximas etapas deste codelab, você vai implementar esses métodos e aprender como eles ajudam a lidar com situações específicas que podem ocorrer no desenvolvimento de jogos.

6. Garantir o envio de relatórios de erros no desenvolvimento

Antes de começar a implementar esses métodos de depuração e ver como eles afetam os relatórios de erros, entenda como os eventos são informados ao Crashlytics.

Em projetos do Unity, os eventos de falha e exceção são gravados imediatamente no disco. Para exceções não identificadas que não causam falhas no jogo (por exemplo, exceções de C# não capturadas na lógica do jogo), é possível fazer com que o SDK do Crashlytics as reporte como eventos fatais definindo a propriedade Crashlytics.ReportUncaughtExceptionsAsFatal como true, em que você inicializa o Crashlytics no seu projeto do Unity. Esses eventos são informados ao Crashlytics em tempo real sem que o usuário final precise reiniciar o jogo. As falhas nativas são sempre relatadas como eventos fatais e enviadas quando um usuário final reinicia o jogo.

Observação: para informar exceções não identificadas como eventos fatais, seu projeto do Unity precisa usar o SDK do Firebase Crashlytics para Unity v10.4.0 e versões posteriores.

Além disso, esteja ciente das seguintes diferenças pequenas, mas significativas, entre a forma como os diferentes ambientes de execução enviam informações do Crashlytics para o Firebase:

Simulador do iOS:

• As informações do Crashlytics serão registradas apenas se você remover o Xcode do simulador. Se o Xcode estiver anexado, ele identificará os erros upstream, impedindo a entrega de informações.

Dispositivos móveis físicos (Android e iOS):

• Específicos do Android: os ANRs são informados apenas no Android 11 e versões mais recentes. Os ANRs e os eventos não fatais são informados na próxima execução.

Editor do Unity:

• As informações do Crashlytics do editor no modo de jogo ou de maneira independente NÃO são gravadas nem enviadas ao Firebase. Além disso, o fluxo de trabalho de desenvolvimento do Firebase Desktop não oferece suporte ao Crashlytics.

Testar uma falha no jogo com o toque de um botão no CrashNow()

Depois que o Crashlytics é configurado no seu jogo, o SDK registra automaticamente falhas e exceções não capturadas e faz upload delas no Firebase para análise. E os relatórios são exibidos no painel do Crashlytics no Console do Firebase.

1. Para demonstrar que isso é realmente automático, abra DebugMenu.cs e substitua o método CrashNow() desta maneira:

   void CrashNow()
   {
       TestCrash();
   }
   

2. Compile seu app.
3. (Somente Android) Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

4. Toque no botão Falha agora e siga para a próxima etapa deste codelab para saber como visualizar e interpretar o relatório de erros.

7. Entender os relatórios de problemas no Console do Firebase

Quando se trata de visualizar seus relatórios de erros, você precisa saber um pouco mais sobre como aproveitá-los ao máximo. Cada um dos métodos que você criar mostrará como adicionar diferentes tipos de informações aos relatórios do Crashlytics.

1. Toque no botão Falha agora e reinicie o app.
2. Acesse o painel do Crashlytics. Role para baixo até a tabela Problemas, na parte de baixo do painel, onde o Crashlytics agrupa eventos com a mesma causa raiz em "Problemas".
3. Clique no novo problema listado na tabela Problemas. Isso faz com que o Resumo do evento seja exibido sobre cada evento que foi enviado ao Firebase.
   
   Você verá algo parecido com a captura de tela a seguir. Observe como o Resumo do evento destaca o stack trace da chamada que levou à falha.

Metadados adicionais

Outra guia útil é Metadados do Unity. Esta seção informa sobre os atributos do dispositivo em que o evento ocorreu, incluindo recursos físicos, o modelo/especificações da CPU e todos os tipos de métricas da GPU.

Confira um exemplo em que as informações dessa guia podem ser úteis:
Imagine que seu jogo usa muitos sombreadores para conseguir uma determinada aparência, mas nem todos os smartphones têm GPUs capazes de renderizar esse recurso. As informações na guia Metadados do Unity podem dar uma ideia melhor de qual hardware seu app deve testar ao decidir quais recursos disponibilizar ou desativar automaticamente.

Talvez um bug ou uma falha nunca aconteça no seu dispositivo, mas devido à enorme diversidade de dispositivos Android disponíveis, é útil entender melhor os "pontos de acesso" específicos dos dispositivos do seu público.

8. Gerar, capturar e registrar uma exceção

Muitas vezes, como desenvolvedor, mesmo que seu código capture e processe corretamente uma exceção de tempo de execução, é bom observar que ela ocorreu e em quais circunstâncias. Crashlytics.LogException pode ser usado exatamente para essa finalidade: enviar um evento de exceção ao Firebase e depurar o problema no Console do Firebase.

1. Em Assets/Hamster/Scripts/States/DebugMenu.cs, anexe o seguinte às instruções using:

   // Import Firebase
   using Firebase.Crashlytics;
   

2. Ainda no DebugMenu.cs, substitua LogNonfatalError() desta forma:

   void LogNonfatalError()
   {
       try
       {
           throw new System.Exception($"Test exception thrown in {nameof(LogNonfatalError)}");
       }
       catch(System.Exception exception)
       {
           Crashlytics.LogException(exception);
       }
   }
   

3. Compile seu app.
4. (Somente Android) Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

5. Toque no botão Registrar erro não fatal e reinicie o app.
6. Acesse o painel do Crashlytics para mostrar algo semelhante ao que mostramos na última etapa deste codelab.
7. No entanto, desta vez, restrinja o filtro Tipo de evento a Não fatais para visualizar apenas erros não fatais, como o que você acabou de registrar.
   

9. Registre strings no Crashlytics para entender melhor o fluxo de execução do programa

Você já tentou descobrir por que uma linha de código que é chamada de vários caminhos (centenas ou milhares de vezes por sessão) pode gerar uma exceção ou falha repentinamente? Embora seja bom percorrer o código em um ambiente de desenvolvimento integrado e analisar os valores mais de perto, e se isso acontecer apenas entre uma pequena porcentagem de usuários desaparece? Pior ainda, o que você faria se não pudesse replicar essa falha, não importa o que fizesse?

Em situações como essa, um pouco de contexto pode fazer toda a diferença. Com Crashlytics.Log, você pode escrever o contexto necessário. Pense nessas mensagens como dicas para seu futuro eu sobre o que pode estar acontecendo.

Embora os registros possam ser usados de inúmeras maneiras, eles geralmente são mais úteis para registrar situações em que a ordem e/ou ausência de chamadas é uma informação extremamente importante.

1. Em Assets/Hamster/Scripts/States/DebugMenu.cs, substitua LogStringsAndCrashNow() desta forma:

   void LogStringsAndCrashNow()
   {
       Crashlytics.Log($"This is the first of two descriptive strings in {nameof(LogStringsAndCrashNow)}");
       const bool RUN_OPTIONAL_PATH = false;
       if(RUN_OPTIONAL_PATH)
       {
           Crashlytics.Log(" As it stands, this log should not appear in your records because it will never be called.");
       }
       else
       {
           Crashlytics.Log(" A log that will simply inform you which path of logic was taken. Akin to print debugging.");
       }
       Crashlytics.Log($"This is the second of two descriptive strings in {nameof(LogStringsAndCrashNow)}");
       TestCrash();
   }
   

2. Compile seu app.
3. (Somente Android) Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

4. Toque no botão Log Strings and Crash Now e reinicie o app.
5. Volte ao painel do Crashlytics e clique no problema mais recente listado na tabela Problemas. Novamente, você verá algo semelhante aos problemas anteriores.
   
6. No entanto, se você clicar na guia Registros em um Resumo do evento, vai ter uma visualização como esta:
   

Observação:esses registros são úteis não apenas para a mensagem, mas também para os carimbos de data/hora, que ajudam a entender a ordem em que foram gerados.

Importante:para evitar que o app fique lento, o Crashlytics limita os registros a 64 KB e exclui entradas mais antigas quando o registro de uma sessão ultrapassa esse limite.

10. Gravar e substituir uma chave personalizada

Digamos que você queira entender melhor uma falha correspondente a variáveis definidas com um número pequeno de valores ou configurações. Pode ser bom poder filtrar, com base na combinação de variáveis e valores possíveis que você está observando, a qualquer momento.

Além de registrar strings arbitrárias, o Crashlytics oferece outra forma de depuração quando é vantajoso saber o estado exato do programa em que ele falhou: chaves personalizadas.

São pares de chave-valor que você pode definir para uma sessão. Ao contrário dos registros que acumulam e são puramente aditivos, as chaves podem ser substituídas para refletir apenas o status mais recente de uma variável ou condição.

Além de serem um registro do último estado registrado do seu programa, essas chaves podem ser usadas como filtros eficientes para problemas do Crashlytics.

1. Em Assets/Hamster/Scripts/States/DebugMenu.cs, substitua SetAndOverwriteCustomKeyThenCrash() desta forma:

   void SetAndOverwriteCustomKeyThenCrash()
   {
       const string CURRENT_TIME_KEY = "Current Time";
       System.TimeSpan currentTime = System.DateTime.Now.TimeOfDay;
       Crashlytics.SetCustomKey(
           CURRENT_TIME_KEY,
           DayDivision.GetPartOfDay(currentTime).ToString() // Values must be strings
           );
   
       // Time Passes
       currentTime += DayDivision.DURATION_THAT_ENSURES_PHASE_CHANGE;
   
       Crashlytics.SetCustomKey(
           CURRENT_TIME_KEY,
           DayDivision.GetPartOfDay(currentTime).ToString()
           );
       TestCrash();
   }
   

2. Compile seu app.
3. (Somente Android) Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

4. Toque no botão Definir chave personalizada e falha e reinicie o app.
5. Volte ao painel do Crashlytics e clique no problema mais recente listado na tabela Problemas. Mais uma vez, você verá algo semelhante aos problemas anteriores.
6. No entanto, desta vez, clique na guia Chaves no Resumo do evento para visualizar o valor das chaves, incluindo Current Time:
   

   Importante: a Chave do crash_info_entry_0 só é preenchida automaticamente pelo Crashlytics quando o app é executado pelo simulador do iOS.

Por que você usaria chaves personalizadas em vez de registros personalizados?

• Os registros são bons para armazenar dados sequenciais, mas as chaves personalizadas são melhores se você quiser apenas o valor mais recente.
• No Console do Firebase, é fácil filtrar os problemas pelos valores das chaves na caixa de pesquisa da tabela Problemas.

No entanto, assim como os registros, as chaves personalizadas têm um limite. O Crashlytics aceita no máximo 64 pares de chave-valor. Ao atingir esse limite, os valores adicionais não serão salvos. Cada par de chave-valor pode ter até 1 KB de tamanho.

11. (Somente Android) Usar chaves e registros personalizados para entender e diagnosticar um ANR

Importante: a classe de problema a seguir se refere principalmente ao Android 11 e versões mais recentes. Se isso não corresponder ao seu caso de uso de desenvolvimento, pule esta seção.

Uma das classes de problemas mais difíceis de depurar para desenvolvedores Android é o erro O app não está respondendo (ANR). Os ANRs ocorrem quando um app não responde à entrada por mais de cinco segundos. Se isso acontecer, significa que o app congelou ou está indo muito lentamente. Uma caixa de diálogo é mostrada aos usuários, e eles podem escolher "Esperar" ou "Fechar app".

Os ANRs são uma experiência do usuário ruim e, como mencionado no link acima, podem afetar a detecção do app na Google Play Store. Devido à complexidade e ao fato de eles geralmente serem causados por código com várias linhas de execução e comportamentos completamente diferentes em modelos de smartphone diferentes, reproduzir ANRs durante a depuração costuma ser muito difícil, se não quase impossível. Em geral, a melhor abordagem é abordá-las de forma analítica e dedutiva.

Nesse método, vamos usar uma combinação de Crashlytics.LogException, Crashlytics.Log e Crashlytics.SetCustomKey para complementar a geração automática de registros de problemas e fornecer mais informações.

Importante:o código de bloqueio é executado na linha de execução de interface do UnityPlayerActivity. Isso não é natural no Unity, já que a linha de execução não é a mesma que a principal, que é o lugar padrão em que o código do jogo é executado. Os ANRs podem ser especialmente difíceis de depurar porque podem ser causados por plug-ins ou outro código executado de maneira não idiomática na linha de execução de interface.

1. Em Assets/Hamster/Scripts/States/DebugMenu.cs, substitua SetLogsAndKeysBeforeANR() desta forma:

   void SetLogsAndKeysBeforeANR()
   {
       System.Action<string,long> WaitAndRecord =
       (string methodName, long targetCallLength)=>
       {
           System.Diagnostics.Stopwatch stopWatch = new System.Diagnostics.Stopwatch();
           const string CURRENT_FUNCTION = "Current Async Function";
   
           // Initialize key and start timing
           Crashlytics.SetCustomKey(CURRENT_FUNCTION, methodName);
           stopWatch.Start();
   
           // The actual (simulated) work being timed.
           BusyWaitSimulator.WaitOnSimulatedBlockingWork(targetCallLength);
   
           // Stop timing
           stopWatch.Stop();
   
           if(stopWatch.ElapsedMilliseconds>=BusyWaitSimulator.EXTREME_DURATION_MILLIS)
           {
             Crashlytics.Log($"'{methodName}' is long enough to cause an ANR.");
           }
           else if(stopWatch.ElapsedMilliseconds>=BusyWaitSimulator.SEVERE_DURATION_MILLIS)
           {
             Crashlytics.Log($"'{methodName}' is long enough it may cause an ANR");
           }
       };
   
       WaitAndRecord("DoSafeWork",1000L);
       WaitAndRecord("DoSevereWork",BusyWaitSimulator.SEVERE_DURATION_MILLIS);
       WaitAndRecord("DoExtremeWork",2*BusyWaitSimulator.EXTREME_DURATION_MILLIS);
   }
   

2. Compile seu app.
3. Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

4. Toque no botão Definir registros e chaves → ANR e reinicie o app.
5. Volte ao painel do Crashlytics e clique no novo problema na tabela Problemas para acessar o Resumo do evento. Se a chamada for bem-sucedida, você verá algo assim:
   
   
   O Firebase identificou a espera ocupada na linha de execução como o principal motivo para o app acionar um ANR.
   
6. Se você analisar os registros na guia Registros do Resumo do evento, vai notar que o último método registrado como concluído é DoSevereWork.
   
   
   Por outro lado, o último método listado como inicial é DoExtremeWork, que indica que o ANR ocorreu durante esse método e o jogo foi fechado antes de registrar DoExtremeWork.
   
   

Importante: se você não encontrar um ANR no Android, mas um erro que menciona um InvalidOperationException, leia os registros. Esse erro personalizado está incluído como parte deste codelab. Siga as instruções, registradas pela exceção, para resolvê-lo. Recrie, implante e itere e você acabará recebendo o erro pretendido.

Por que fazer isso?

• A reprodução de ANRs é incrivelmente difícil, portanto, a possibilidade de conseguir informações valiosas sobre a área e as métricas do código é extremamente importante para fazer isso de forma dedutiva.
• Com as informações armazenadas nas chaves personalizadas, agora você sabe qual linha de execução assíncrona levou mais tempo para ser executada e quais correm o risco de acionar ANRs. Esse tipo de dados lógicos e numéricos relacionados mostrará onde no seu código é mais necessário otimizar.

12. Intercalar eventos do Analytics para enriquecer ainda mais os relatórios

Os métodos a seguir também podem ser chamados no menu de depuração. No entanto, em vez de gerar problemas, eles usam o Google Analytics como outra fonte de informações para entender melhor o funcionamento do jogo.

Ao contrário dos outros métodos que você criou neste codelab, use-os em combinação com os outros. Chame esses métodos (pressionando o botão correspondente no menu de depuração) em qualquer ordem arbitrária que você quiser antes de executar um dos outros. Em seguida, ao examinar as informações no problema específico do Crashlytics, você verá um registro ordenado dos eventos do Analytics. Esses dados podem ser usados em um jogo para entender melhor uma combinação do fluxo do programa ou da entrada do usuário, dependendo de como você instrumentou seu aplicativo.

Observação: os casos de uso a seguir são bastante simples para o Google Analytics. Os detalhes do Analytics estão além do escopo deste codelab. Se quiser saber mais, entender melhor o que é registrado com precisão ou saber como depurar o processo de geração de relatórios, consulte Introdução ao Google Analytics para Unity.

1. Em Assets/Hamster/Scripts/States/DebugMenu.cs, substitua as implementações atuais dos seguintes métodos:

   public void LogProgressEventWithStringLiterals()
   {
         Firebase.Analytics.FirebaseAnalytics.LogEvent("progress", "percent", 0.4f);
   }
   

   public void LogIntScoreWithBuiltInEventAndParams()
   {
         Firebase.Analytics.FirebaseAnalytics
           .LogEvent(
             Firebase.Analytics.FirebaseAnalytics.EventPostScore,
             Firebase.Analytics.FirebaseAnalytics.ParameterScore,
             42
           );
   }
   

2. Crie e implante seu jogo e acesse o Menu de depuração.
3. (Somente Android) Faça upload dos símbolos executando o seguinte comando da CLI do Firebase:

   firebase crashlytics:symbols:upload --app=<FIREBASE_APP_ID> <PATH/TO/SYMBOLS>
   

4. Pressione pelo menos um dos botões a seguir uma ou mais vezes para chamar as funções acima:
   • Evento de string de registro
   • Evento de login de login
5. Pressione o botão Crash Now.
6. Reinicie o jogo para que ele faça upload do evento de falha para o Firebase.
7. Quando você registra várias sequências arbitrárias de eventos do Analytics e faz com que seu jogo gere um evento a partir do qual o Crashlytics cria um relatório (como você acabou de fazer), eles são adicionados à guia Registros do Resumo de eventos do Crashlytics da seguinte forma:
   

Importante:os eventos personalizados podem levar mais tempo para aparecer no painel do Analytics no Console do Firebase do que em um registro de falhas no painel do Crashlytics. Além disso, é possível que os eventos do Analytics não apareçam nos dois locais imediatamente após serem registrados.

13. O futuro

Com isso, você terá uma base teórica melhor para complementar os relatórios de erros gerados automaticamente. Essas novas informações permitem que você use o estado atual, os registros de eventos anteriores e os eventos atuais do Google Analytics para detalhar melhor a sequência de eventos e a lógica que levou ao resultado.

Caso o app seja destinado ao Android 11 (nível 30 da API) ou versões mais recentes, considere incorporar o GWP-ASan, um recurso de alocador de memória nativo útil para depurar falhas causadas por erros de memória nativa, como bugs use-after-free e heap-buffer-overflow. Para aproveitar esse recurso de depuração, ative explicitamente o GWP-ASan.

Próximas etapas

Prossiga para o codelab Instrumentar seu jogo do Unity com a Configuração remota, em que você vai aprender a usar a Configuração remota e o Teste A/B no Unity.