Começar a usar o Firebase Crashlytics

iOS+ Android Flutter Unity

Neste guia de início rápido, vamos mostrar como configurar o Firebase Crashlytics no seu app com o SDK do Firebase Crashlytics para receber relatórios de erros abrangentes no console do Firebase. Com o Crashlytics para Android, você recebe relatórios sobre falhas, erros não fatais e erros do tipo O app não está respondendo (ANR).

A configuração do Crashlytics exige tarefas no console do Firebase e no ambiente de desenvolvimento integrado, como adicionar um arquivo de configuração do Firebase e o SDK do Crashlytics. Para concluir a configuração, você terá que forçar uma falha de teste para enviar seu primeiro relatório de erros ao Firebase.

Antes de começar

1. Adicione o Firebase ao projeto para Android, caso ainda não tenha feito isso. Caso você não tenha um app Android, faça o download de um app de exemplo.

2. Recomendado: para gerar automaticamente registros de navegação estrutural e entender as ações do usuário que levam a uma falha, um evento não fatal ou um ANR, você precisa para ativar o Google Analytics no seu projeto do Firebase.

   • Se o Google Analytics não estiver ativado no seu projeto do Firebase, ative o Google Analytics na guia Integrações das suas > Configurações do projeto no console do Firebase.

   • Se você estiver criando um novo projeto do Firebase, ative o Google Analytics durante a criação.

3. Verifique se o app tem estas versões mínimas necessárias:

   • Gradle 8.0
   • Plug-in do Android para Gradle 8.1.0
   • Plug-in do Google Services para Gradle 4.4.1

Etapa 1: adicionar o SDK do Crashlytics ao seu app

Seu app usa o NDK? Acesse a documentação do relatório de erros do NDK e veja como configurar o Crashlytics para registrar falhas que ocorrem nas bibliotecas do NDK do app.

No arquivo Gradle do módulo (nível do app) (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), adicione a dependência da biblioteca do Crashlytics para Android. Recomendamos o uso do Firebase Android BoM para controlar o controle de versões da biblioteca.

Para aproveitar os registros de navegação estrutural, adicione também o SDK do Firebase para Google Analytics ao seu app. Verifique se o Google Analytics está ativado no seu projeto do Firebase.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependencies for the Crashlytics and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics")
    implementation("com.google.firebase:firebase-analytics")
}

Com a Firebase Android BoM, seu app sempre vai usar versões compatíveis das bibliotecas do Firebase para Android.

(Alternativa) Adicionar dependências das bibliotecas do Firebase sem usar o BoM

Se você preferir não usar o Firebase BoM, especifique cada versão das bibliotecas do Firebase na linha de dependência correspondente.

Se você usa várias bibliotecas do Firebase no app, recomendamos utilizar o BoM para gerenciar as versões delas, porque isso ajuda a garantir a compatibilidade de todas as bibliotecas.

dependencies {
    // Add the dependencies for the Crashlytics and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics:19.2.1")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

Está procurando um módulo de biblioteca específico do Kotlin? A partir de outubro de 2023 (Firebase BoM 32.5.0), os desenvolvedores Kotlin e Java poderão depender do módulo da biblioteca principal. Para mais detalhes, consulte as Perguntas frequentes sobre essa iniciativa.

Etapa 2: adicionar ao seu app o plug-in do Gradle para o Crashlytics

1. No seu arquivo Gradle de nível raiz (do projeto) (<project>/build.gradle.kts ou <project>/build.gradle), adicione o plug-in do Gradle para Crashlytics ao bloco plugins:

   Kotlin

   Você ainda usa a sintaxe buildscript? Saiba como adicionar plug-ins do Firebase usando essa sintaxe.

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id("com.android.application") version "8.1.4" apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id("com.google.gms.google-services") version "4.4.2" apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id("com.google.firebase.crashlytics") version "3.0.2" apply false
   }

   Groovy

   Você ainda usa a sintaxe buildscript? Saiba como adicionar plug-ins do Firebase usando essa sintaxe.

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id 'com.android.application' version '8.1.4' apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id 'com.google.gms.google-services' version '4.4.2' apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics' version '3.0.2' apply false
   }

   Seu app usa uma versão antiga do Gradle? Considere fazer o upgrade. Caso contrário, use a v2.9.9 do plug-in do Gradle para Crashlytics.

2. No arquivo Gradle do módulo (nível do app) (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), adicione o plug-in do Gradle para Crashlytics:

   Kotlin

   plugins {
     id("com.android.application")
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id("com.google.gms.google-services")
   
     // Add the Crashlytics Gradle plugin
     id("com.google.firebase.crashlytics")
   }

   Groovy

   plugins {
     id 'com.android.application'
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id 'com.google.gms.google-services'
   
     // Add the Crashlytics Gradle plugin
     id 'com.google.firebase.crashlytics'
   }

Etapa 3: forçar uma falha de teste para concluir a configuração

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

1. Adicione um código ao app que possa ser usado para forçar uma falha no teste.

   É possível usar o código a seguir no MainActivity do seu app para adicionar um botão que, quando pressionado, causa uma falha. O botão é chamado de "Testar falha".

   Kotlin+KTX

   val crashButton = Button(this)
   crashButton.text = "Test Crash"
   crashButton.setOnClickListener {
      throw RuntimeException("Test Crash") // Force a crash
   }
   
   addContentView(crashButton, ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT))

   Java

   Button crashButton = new Button(this);
   crashButton.setText("Test Crash");
   crashButton.setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
          throw new RuntimeException("Test Crash"); // Force a crash
      }
   });
   
   addContentView(crashButton, new ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT));

2. Crie e execute seu app.

3. Force a falha de teste para enviar o primeiro relatório de erros do app:

   1. Abra o app no dispositivo ou emulador de teste.

   2. No app, pressione o botão "Testar falha" que você adicionou usando o código acima.

   3. Depois que o app falhar, reinicie-o para que ele possa enviar o relatório de falhas ao Firebase.

4. Acesse o painel do Crashlytics no console do Firebase para ver a falha do teste.

   Se você já atualizou o console e ainda não está vendo a falha de teste depois de cinco minutos, ative a geração de registros de depuração para ver se o app está enviando relatórios de falha.

Pronto. O Crashlytics já está monitorando seu app em busca de falhas, erros não fatais e ANRs. Acesse o painel do Crashlytics para ver e analisar todos os relatórios e estatísticas.

Próximas etapas

• Para personalizar a configuração do relatório de erros, adicione a permissão de geração de relatórios, registros, chaves e rastreamento de erros não fatais.

• Faça a integração com o Google Play para filtrar os relatórios de erros do app Android pela faixa do Google Play diretamente no painel do Crashlytics. Isso permite que você configure o painel para monitorar builds específicos.

• No Android Studio, visualize e filtre dados do Crashlytics.
  • Use a janela App Quality Insights (AQI) no Android Studio para verificar os dados do Crashlytics e o seu código. Para começar a depurar os problemas principais, você não precisa ficar indo e voltando entre o painel do Crashlyticse o ambiente de desenvolvimento integrado.
  • Saiba como usar a janela AQI na documentação do Android Studio.
  • Sua opinião é importante para nós. Envie seu feedback sobre a janela AQI preenchendo um relatório de bug.