Primeiros passos com o Monitoramento de desempenho para plataformas para Apple

Antes de começar

Adicione o Firebase ao seu projeto da Apple caso ainda não tenha feito isso.

Observação: o Firebase oferece suporte ao CocoaPods e ao Swift Package Manager. Se você instalar o Firebase usando o Swift Package Manager, poderá pular etapas relacionadas ao CocoaPods, como modificar Podfiles e executar o comando pod.

Etapa 1: adicionar o Monitoramento de desempenho ao seu app

Depois que você adiciona o SDK do Monitoramento de desempenho, o Firebase começa a coletar dados automaticamente sobre a renderização de tela do seu app, incluindo os dados relacionados ao ciclo de vida do seu aplicativo (como o horário de início do app) e dados das solicitações de rede HTTP/S.

Use o Swift Package Manager para instalar e gerenciar as dependências do Firebase.

Acesse nosso guia de instalação e conheça as diferentes maneiras de adicionar SDKs do Firebase ao seu projeto da Apple, incluindo detalhes sobre importação direta de frameworks e uso do CocoaPods.

1. No Xcode, com seu projeto do app aberto, navegue até File > Add Packages.
2. Quando solicitado, adicione o repositório do SDK do Firebase para as plataformas Apple:

  https://github.com/firebase/firebase-ios-sdk.git

Observação: novos projetos precisam usar a versão padrão (mais recente) do SDK, mas você pode escolher uma mais antiga, se necessário.
3. Escolha a biblioteca do Monitoramento de desempenho.
4. Adicione a sinalização -ObjC à seção Outras sinalizações do vinculador das configurações de compilação do destino.
5. Quando terminar, o Xcode vai começar a resolver e fazer o download das dependências em segundo plano automaticamente.

Em seguida, configure o módulo do Firebase:

1. Importe o módulo FirebaseCore no UIApplicationDelegate, assim como qualquer outro módulo do Firebase usado pelo delegado do app. Por exemplo, para usar o Cloud Firestore e o Authentication:

   SwiftUI

   import SwiftUI
   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Swift

   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Objective-C

   @import FirebaseCore;
   @import FirebaseFirestore;
   @import FirebaseAuth;
   // ...
         

2. Configure uma instância compartilhada do FirebaseApp no método application(_:didFinishLaunchingWithOptions:) do delegado do app:

   SwiftUI

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Swift

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Objective-C

   // Use Firebase library to configure APIs
   [FIRApp configure];

3. Se você estiver usando a SwiftUI, crie um delegado do aplicativo e o anexe ao struct App via UIApplicationDelegateAdaptor ou NSApplicationDelegateAdaptor. Também é necessário desativar o swizzling do delegado do app. Para mais informações, consulte as instruções da SwiftUI.

   SwiftUI

   @main
   struct YourApp: App {
     // register app delegate for Firebase setup
     @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
   
     var body: some Scene {
       WindowGroup {
         NavigationView {
           ContentView()
         }
       }
     }
   }
         

4. Recompile o app.

Observação: ao adicionar o Monitoramento de desempenho ao seu app, o SDK da Configuração remota é incluído como uma dependência. Se você já usa a Configuração remota, não verá nenhuma diferença. No entanto, se ainda não conhece esse recurso, consulte a documentação dele para saber mais sobre as funcionalidades que você poderá acessar no seu app.

Etapa 2: gerar eventos de desempenho para a exibição inicial de dados

O Firebase começa a processar os eventos quando você adiciona o SDK ao seu aplicativo. Se você ainda estiver desenvolvendo localmente, interaja com seu aplicativo para gerar eventos para coleta e processamento de dados iniciais.

Observação: o SDK do Monitoramento de desempenho agrupa os eventos localmente e os envia ao Firebase a cada 30 segundos ou quando o app volta para o primeiro plano. Portanto, há um atraso entre uma interação do app e quando o Firebase recebe as informações de evento do aplicativo.

1. Continue desenvolvendo o app usando um simulador ou dispositivo de teste.

2. Gere eventos alternando o plano de fundo e o primeiro plano do app várias vezes. Interaja com o app navegando pelas telas e/ou acionando solicitações de rede.

3. Acesse o painel Desempenho do console do Firebase. Você verá sua exibição de dados inicial em alguns minutos.

   Se você não vir uma exibição dos seus dados iniciais, veja as dicas de solução de problemas.

Etapa 3: (opcional) ver se há eventos de desempenho nas mensagens de registro

1. Ative a geração de registros de depuração da seguinte maneira:

   1. No Xcode (versão mínima 15.2), selecione Product > Scheme > Edit scheme.
   2. Selecione Run no menu à esquerda e depois a guia Arguments.
   3. Na seção Arguments Passed on Launch, adicione -FIRDebugEnabled.

2. Verifique se há mensagens de erro nas mensagens de registro.

3. O Monitoramento de desempenho marca as mensagens de registro com Firebase/Performance para que você possa filtrá-las.

4. Verifique os seguintes tipos de registro que indicam que o Monitoramento de desempenho está registrando eventos de desempenho:

   • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
   • Logging network request trace: URL

5. Clique no URL para ver seus dados no Console do Firebase. Pode levar alguns instantes até que os dados sejam atualizados no painel.

Se o app não estiver registrando eventos de desempenho, veja as dicas de solução de problemas.

Etapa 4 (opcional): adicionar monitoramento personalizado para código específico

Para monitorar os dados de desempenho associados a um código específico no app, instrumente traces de código personalizados.

Com um trace de código personalizado, é possível avaliar quanto tempo o app leva para concluir uma tarefa específica ou um conjunto de tarefas, como carregar um conjunto de imagens ou consultar seu banco de dados. A métrica padrão de um trace de código personalizado é a duração, mas também é possível adicionar métricas personalizadas, como ocorrências em cache e avisos de memória.

No seu código, você define o início e o fim de um trace de código personalizado (e adiciona a métrica personalizada que quiser) usando a API fornecida pelo SDK do Monitoramento de desempenho.

Acesse Adicionar monitoramento para códigos específicos para saber mais sobre esses recursos e como adicioná-los ao seu app.

Etapa 5: implantar seu app e analisar os resultados

Depois de validar o Monitoramento de desempenho usando o simulador Xcode e um ou mais dispositivos de teste, você será capaz de implantar a versão atualizada do seu app para os usuários.

Você pode monitorar os dados de desempenho no painel Desempenho do Console do Firebase.

Problemas conhecidos

• O Monitoramento de desempenho tem problemas de compatibilidade conhecidos com o GTMSQLite. Recomendamos não usar o Monitoramento de desempenho com apps que usam GTMSQLite.
• O swizzling de métodos após chamar FirebaseApp.configure() pode interferir no SDK do Monitoramento de desempenho.
• Problemas conhecidos no simulador de iOS 8.0 a 8.2 impedem o Monitoramento de desempenho de capturar eventos de desempenho. Esses problemas são corrigidos no simulador de iOS 8.3 e versões posteriores.
• As conexões estabelecidas usando o backgroundSessionConfiguration da NSURLSession terão tempos de conexão mais longos do que o esperado. Essas conexões são executadas fora do processo, e o tempo reflete os eventos de callback no processo.

Próximas etapas

• Revise e execute o exemplo do código do Monitoramento de desempenho para iOS no GitHub.

• Saiba mais sobre os dados coletados automaticamente pelo Monitoramento de desempenho:

  • Dados relacionados ao ciclo de vida do app, como o horário de início.
  • Dados para renderização de tela no app.
  • Dados para solicitações de rede HTTP/S emitidos pelo app.

• Visualize, acompanhe e filtre os dados de desempenho no Console do Firebase.

• Adicione o monitoramento para tarefas ou fluxos de trabalho específicos no app instrumentando traces de código personalizados.

• Use atributos para filtrar dados de desempenho.