1. Visão geral
Neste codelab, você vai aprender a monitorar o desempenho do seu app durante o lançamento de um recurso. O app de exemplo terá uma funcionalidade básica e será configurado para mostrar uma imagem de plano de fundo diferente com base em uma flag da Configuração remota do Firebase. Vamos abordar a instrumentação de rastros para monitorar o desempenho do app, lançar uma mudança de configuração no app, monitorar o efeito e descobrir como melhorar a performance.
O que você vai aprender
- Como adicionar o Monitoramento de desempenho do Firebase ao seu app para dispositivos móveis e receber métricas prontas para uso, como horário de início do app e frames lentos ou congelados
- Como adicionar traces personalizados para entender os caminhos críticos do código das jornadas do usuário
- Como usar o painel do Monitoramento de desempenho para entender suas métricas e acompanhar alterações importantes, como o lançamento de um recurso.
- Como configurar alertas de performance para monitorar as principais métricas
- Como implementar uma alteração na Configuração remota do Firebase
Pré-requisitos
- Android Studio 4.0 ou mais recente
- Um Android Emulator com o nível 16 da API ou mais recente.
- Java versão 8 ou mais recente
- Conhecimentos básicos sobre a Configuração remota do Firebase.
2. Configurar o projeto de amostra
Fazer o download do código
Execute o comando a seguir para clonar o código de exemplo deste codelab. Isso vai criar uma pasta chamada codelab-perf-rc-android
na sua máquina:
$ git clone https://github.com/FirebaseExtended/codelab-feature-rollout-performance.git
Se você não tiver o Git na sua máquina, também poderá fazer o download do código diretamente do GitHub.
Importe o projeto na pasta firebase-perf-rc-android-start
no Android Studio. Você provavelmente vai encontrar algumas exceções de execução ou talvez um aviso sobre um arquivo google-services.json
ausente. Vamos corrigir isso na próxima seção.
Neste codelab, você vai usar o plug-in do Firebase Assistente para registrar seu app Android com um projeto do Firebase e adicionar os arquivos de configuração, plug-ins e dependências necessários ao seu projeto do Android. Tudo isso no Android Studio.
Conectar seu app ao Firebase
- Acesse Android Studio/Help > Verifique se há atualizações para confirmar se você está usando as versões mais recentes do Android Studio e do Firebase Assistente.
- Selecione Ferramentas > Firebase para abrir o painel do Assistente.
- Escolha Monitoramento de desempenho para adicionar ao app e clique em Começar a usar o Monitoramento de desempenho.
- Clique em Conectar ao Firebase para conectar seu projeto do Android ao Firebase (isso abrirá o console do Firebase no seu navegador).
- No console do Firebase, clique em Adicionar projeto e insira um nome de projeto do Firebase (se você já tiver um projeto do Firebase, selecione esse projeto). Clique em Continuar e aceite os termos para criar o projeto e um novo app do Firebase.
Em seguida, uma caixa de diálogo vai aparecer para conectar o novo app do Firebase ao projeto do Android Studio.
- Clique em Conectar.
- Abra o Android Studio. No painel Assistente, você vai encontrar a confirmação de que o app está conectado ao Firebase.
Adicionar o Monitoramento de desempenho ao app
No painel Assistente do Android Studio, clique em Adicionar o Monitoramento de desempenho ao seu app.
Uma caixa de diálogo Accept Changes vai aparecer. Depois disso, o Android Studio vai sincronizar o app para garantir que todas as dependências necessárias tenham sido adicionadas.
Por fim, você vai ver a mensagem de sucesso no painel Assistente no Android Studio, indicando que todas as dependências foram configuradas corretamente.
Como etapa adicional, ative a geração de registros de depuração seguindo as instruções na etapa "(Opcional) Ativar a geração de registros de depuração". As mesmas instruções também estão disponíveis na documentação pública.
3. Execute o aplicativo
Agora você verá o arquivo google-services.json
no diretório do módulo (nível do app) do app, que será compilado. No Android Studio, clique em Run > Run "app" para criar e executar o app no emulador do Android.
Quando o app estiver em execução, você vai encontrar primeiro uma tela de apresentação como esta:
Depois de alguns segundos, a página principal com a imagem padrão vai aparecer:
O que está acontecendo nos bastidores?
A tela de apresentação é implementada em SplashScreenActivity e faz o seguinte:
- Em
onCreate()
, inicializamos as configurações da Configuração remota do Firebase e buscamos os valores que você vai definir no painel da Configuração remota mais adiante neste codelab. - No
executeTasksBasedOnRC()
, lemos o valor de configuração da sinalizaçãoseasonal_image_url
. Se um URL for fornecido pelo valor de configuração, faremos o download da imagem de forma síncrona. - Quando o download for concluído, o app vai navegar para MainActivity e chamar
finish()
para encerrarSplashScreenActivity
.
Em MainActivity
, se seasonal_image_url
for definido pela Configuração remota, o recurso será ativado e a imagem salva será exibida como plano de fundo da página principal. Caso contrário, a imagem padrão (mostrada acima) será exibida.
4. Configurar a Configuração remota
Agora que o app está em execução, você pode configurar a nova flag de recurso.
- No painel esquerdo do Console do Firebase, localize a seção Engage e clique em Configuração remota.
- Clique no botão Criar configuração para abrir o formulário de configuração e adicione
seasonal_image_url
como a chave de parâmetro. - Clique em Adicionar descrição e digite esta descrição:
Shows a seasonal image (replaces default) in the main page when the restaurant list is empty.
- Clique em Adicionar novo -> Valor condicional -> Criar nova condição.
- Para o nome da condição, insira
Seasonal image rollout
. - Para a seção
Applies if...
, selecioneUser in random percentile <= 0%
. (Deixe o recurso desativado até que esteja tudo pronto para o lançamento em uma etapa posterior.) - Clique em Criar condição. Você usará essa condição posteriormente para lançar o novo recurso para seus usuários.
- Abra o formulário Criar seu primeiro parâmetro e localize o campo Valor para lançamento sazonal da imagem. Insira o URL de onde será feito o download da imagem sazonal:
https://images.unsplash.com/photo-1552691021-7043334e0b51
- Deixe o valor padrão como uma string vazia. Isso significa que a imagem padrão na base de código será mostrada em vez de uma imagem baixada de um URL.
- Clique em Salvar.
A nova configuração foi criada como um rascunho.
- Clique em Publicar mudanças e confirme as alterações na parte de cima para atualizar o app.
5. Adicionar monitoramento para o tempo de carregamento de dados
O app carrega alguns dados antes de mostrar MainActivity
e exibe uma tela de apresentação para ocultar esse processo. Você não quer que os usuários esperem muito nessa tela. Por isso, normalmente é benéfico monitorar por quanto tempo a tela de apresentação é exibida.
O Monitoramento de desempenho do Firebase oferece uma maneira de fazer exatamente isso. É possível instrumentar traces de código personalizados para monitorar o desempenho de um código específico no app, como o tempo de carregamento de dados e o tempo de processamento do novo recurso.
Para monitorar por quanto tempo a tela de apresentação é mostrada, adicione um trace de código personalizado ao SplashScreenActivity
, que é o Activity
que implementa a tela de apresentação.
- Inicialize, crie e inicie um trace de código personalizado chamado
splash_screen_trace
:
SplashScreenActivity.java
// ...
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;
// ...
public class SplashScreenActivity extends AppCompatActivity {
private static final String TAG = "SplashScreenActivity";
private static final String SEASONAL_IMAGE_URL_RC_FLAG = "seasonal_image_url";
// TODO: Initialize splash_screen_trace
private final Trace splashScreenTrace = FirebasePerformance.startTrace("splash_screen_trace");
// ...
}
- Encerre o rastreamento no método
onDestroy()
deSplashScreenActivity
:
SplashScreenActivity.java (link em inglês)
@Override
protected void onDestroy() {
super.onDestroy();
// TODO: Stop the splash_screen_trace here
splashScreenTrace.stop();
}
Como o novo recurso faz o download e processa uma imagem, você vai adicionar um segundo trace de código personalizado que vai rastrear o tempo adicional que o recurso adicionou a SplashScreenActivity
.
- Inicialize, crie e inicie um trace de código personalizado chamado
splash_seasonal_image_processing
:
SplashScreenActivity.java
private void executeTasksBasedOnRC(FirebaseRemoteConfig rcConfig) {
String seasonalImageUrl = rcConfig.getString(SEASONAL_IMAGE_URL_RC_FLAG);
Log.d(TAG, SEASONAL_IMAGE_URL_RC_FLAG + ": " + seasonalImageUrl);
if (!seasonalImageUrl.isEmpty()) {
// TODO: Start the splash_seasonal_image_processing here
final Trace seasonalImageProcessingTrace = FirebasePerformance
.startTrace("splash_seasonal_image_processing");
// ...
}
}
- Encerre o rastreamento nos métodos
onLoadFailed()
eonResourceReady()
doRequestListener
:
SplashScreenActivity.java (link em inglês)
Glide.with(SplashScreenActivity.this.getApplicationContext())
.asBitmap()
.load(seasonalImageUrl)
.signature(new ObjectKey(Utils.getCacheUUID()))
.listener(new RequestListener<Bitmap>() {
@Override
public boolean onLoadFailed(
@Nullable GlideException e,
Object model, Target<Bitmap> target,
boolean isFirstResource) {
// TODO: Stop the splash_seasonal_image_processing here
seasonalImageProcessingTrace.stop();
launchMainActivity();
return true;
}
@Override
public boolean onResourceReady(Bitmap resource, Object model,
Target<Bitmap> target, DataSource dataSource,
boolean isFirstResource) {
// TODO: Stop the splash_seasonal_image_processing here
seasonalImageProcessingTrace.stop();
launchMainActivity();
return true;
}
})
.preload();
Agora que você adicionou traces de código personalizados para monitorar a duração da tela de apresentação (splash_screen_trace)
e o tempo de processamento do novo recurso (splash_seasonal_image_processing
), execute o app novamente no Android Studio. Você verá uma mensagem de geração de registros contendo Logging trace metric: splash_screen_trace
, seguida pela duração do trace. Você não vai receber uma mensagem de registro para splash_seasonal_image_processing
porque ainda não ativou o novo recurso.
6. Adicionar um atributo personalizado ao trace
Em relação a traces de código personalizados, o Monitoramento de desempenho registra automaticamente os atributos padrão (metadados comuns, como versão do app, país, dispositivo etc.) para que você filtre os dados do trace no console do Firebase. Também é possível adicionar e monitorar atributos personalizados.
Você acabou de adicionar dois traces de código personalizados no app para monitorar a duração da tela de apresentação e o tempo de processamento do novo recurso. Um fator que pode afetar essas durações é se a imagem exibida é a imagem padrão ou se ela precisa ser transferida por download de um URL. E, quem sabe, você pode acabar com URLs diferentes dos quais você faz o download de uma imagem.
Então, vamos adicionar um atributo personalizado que representa o URL sazonal da imagem a esses traces de código personalizados. Dessa forma, é possível filtrar os dados de duração por esses valores mais tarde.
- Adicione o atributo personalizado (
seasonal_image_url_attribute
) parasplash_screen_trace
no início do métodoexecuteTasksBasedOnRC
:
SplashScreenActivity.java (link em inglês)
private void executeTasksBasedOnRC(FirebaseRemoteConfig rcConfig) {
String seasonalImageUrl = rcConfig.getString(SEASONAL_IMAGE_URL_RC_FLAG);
Log.d(TAG, SEASONAL_IMAGE_URL_RC_FLAG + ": " + seasonalImageUrl);
// TODO: Add a custom attribute "seasonal_image_url_attribute" to splash_screen_trace
if (seasonalImageUrl.isEmpty()) {
splashScreenTrace.putAttribute("seasonal_image_url_attribute", "unset");
} else {
splashScreenTrace.putAttribute("seasonal_image_url_attribute", seasonalImageUrl);
}
// ...
}
- Adicione o mesmo atributo personalizado para
splash_seasonal_image_processing
logo após a chamada destartTrace("splash_seasonal_image_processing")
:
SplashScreenActivity.java (link em inglês)
if (!seasonalImageUrl.isEmpty()) {
// TODO: Start the splash_seasonal_image_processing here
final Trace seasonalImageProcessingTrace = FirebasePerformance
.startTrace("splash_seasonal_image_processing");
// TODO: Add a custom attribute "seasonal_image_url_attribute" to splash_seasonal_image_processing
seasonalImageProcessingTrace
.putAttribute("seasonal_image_url_attribute", seasonalImageUrl);
// ...
}
Agora que você adicionou um atributo personalizado (seasonal_image_url_attribute
) para os dois rastros personalizados (splash_screen_trace
e splash_seasonal_image_processing
), execute o app no Android Studio novamente. Uma mensagem de registro com Setting attribute 'seasonal_image_url_attribute' to 'unset' on trace 'splash_screen_trace'.
vai aparecer. Você ainda não ativou o parâmetro seasonalImageUrl da Configuração remota. É por isso que o valor do atributo é unset
.
O SDK do Monitoramento de desempenho vai coletar os dados de rastreamento e enviá-los ao Firebase. É possível ver os dados no painel Desempenho do Console do Firebase, que vamos explicar em detalhes na próxima etapa do codelab.
7. Configurar o painel do Monitoramento de desempenho
Configurar o painel para monitorar o recurso
No Console do Firebase, selecione o projeto que contém o app Friendly Eats.
No painel esquerdo, localize a seção Liberar e Monitorar e em Desempenho.
O painel Performance vai aparecer com os primeiros pontos de dados no seu quadro de métricas. O SDK do Monitoramento de desempenho coleta dados de performance do seu app e os exibe minutos após a coleta.
Nesse quadro, você pode acompanhar as principais métricas do seu aplicativo. A visualização padrão inclui a duração do trace do horário de início do app, mas você pode adicionar as métricas mais importantes para você. Como você está acompanhando o novo recurso adicionado, é possível personalizar seu painel para mostrar a duração do trace de código personalizado splash_screen_trace
.
- Clique em uma das caixas vazias em Selecionar uma métrica.
- Na janela de diálogo, selecione o tipo de trace Traces personalizados e o nome do trace
splash_screen_trace
.
- Clique em Selecionar métrica. A duração de
splash_screen_trace
vai aparecer no seu painel.
Use essas mesmas etapas para adicionar outras métricas importantes para você ver rapidamente como o desempenho delas muda ao longo do tempo e mesmo com versões diferentes.
O quadro de métricas é uma ferramenta eficiente para acompanhar o desempenho das principais métricas que os usuários veem. Neste codelab, você tem um pequeno conjunto de dados em um período curto. Portanto, você vai usar outras visualizações do painel que ajudarão a entender o desempenho do lançamento do recurso.
8. Lançar o recurso
Agora que você configurou o monitoramento, está tudo pronto para implementar a mudança na Configuração remota do Firebase (seasonal_image_url)
) que você configurou anteriormente.
Para implementar uma mudança, volte à página Configuração remota no console do Firebase para aumentar a porcentagem de usuários da sua condição de segmentação. Normalmente, você lançaria novos recursos para uma pequena parte dos usuários e os aumentaria apenas quando tiver certeza de que não há problemas com eles. No entanto, neste codelab, você é o único usuário do app, então pode mudar a porcentagem para 100%.
- Clique na guia Condições na parte de cima da página.
- Clique na condição
Seasonal image rollout
adicionada anteriormente. - Mude a porcentagem para 100%.
- Clique em Salvar condição.
- Clique em Publicar alterações e confirme as mudanças.
De volta ao Android Studio, reinicie o app no emulador para conferir o novo recurso. Após a tela de apresentação, a nova tela principal de estado vazio vai aparecer.
9. Verificar as mudanças no desempenho
Agora, vamos verificar o desempenho do carregamento da tela de apresentação usando o painel Desempenho no Console do Firebase. Nesta etapa do codelab, você vai usar diferentes partes do painel para visualizar dados de desempenho.
- Na guia principal Painel, role para baixo até a tabela de traces e clique na guia Traces personalizados. Nessa tabela, você vai encontrar os traces de código personalizados que adicionou anteriormente, além de alguns traces prontos para uso.
- Agora que você ativou o novo recurso, procure o rastreamento de código personalizado
splash_seasonal_image_processing
, que mediu o tempo necessário para fazer o download e processar a imagem. Pelo valor de Duração do rastreamento, é possível notar que esse download e processamento leva um tempo significativo.
- Como você tem dados de
splash_seasonal_image_processing
, é possível adicionar a duração desse trace ao quadro de métricas na parte superior da guia Painel.
Assim como antes, clique em uma das caixas vazias Selecionar uma métrica. Na janela de diálogo, selecione o tipo de trace Traces personalizados e o nome do trace splash_seasonal_image_processing
. Por fim, clique em Selecionar métrica para adicionar essa métrica ao painel de métricas.
- Para confirmar melhor as diferenças, analise mais de perto os dados de
splash_screen_trace
. Clique no cardsplash_screen_trace
no quadro de métricas e depois em Ver detalhes das métricas.
- Na página de detalhes, você vai encontrar uma lista de atributos no canto inferior esquerdo, incluindo o atributo personalizado que criou anteriormente. Clique no atributo personalizado
seasonal_image_url_attribute
para conferir a duração da tela de apresentação de cada URL sazonal de imagem à direita:
- Os valores de duração da tela de apresentação provavelmente serão um pouco diferentes dos mostrados na captura de tela acima, mas você vai precisar de uma duração mais longa quando a imagem for transferida por download de um URL em vez de usar a imagem padrão (representada por "não definido").
Neste codelab, o motivo dessa duração mais longa pode ser simples, mas em um app real, pode não ser tão óbvio. Os dados de duração coletados vêm de dispositivos diferentes, executando o app em várias condições de conexão de rede, e essas condições podem ser piores do que o esperado. Vamos analisar como você investigaria esse problema se fosse uma situação real.
- Clique em Desempenho na parte de cima da página para voltar à guia principal do Painel:
- Na tabela de traces na parte inferior da página, clique na guia Solicitações de rede. Nesta tabela, você vai encontrar todas as solicitações de rede do seu app agregadas em padrões de URL, incluindo o padrão de URL
images.unsplash.com/**
. Se você comparar o valor desse tempo de resposta com o tempo total de download e processamento da imagem (ou seja, a duração do tracesplash_seasonal_image_processing
), vai notar que uma grande parte do tempo é gasto no download da imagem.
Resultados de desempenho
Com o Monitoramento de desempenho do Firebase, você observou o seguinte impacto nos usuários finais com o novo recurso ativado:
- O tempo gasto no app
SplashScreenActivity
aumentou. - A duração de
splash_seasonal_image_processing
foi muito longa. - O atraso ocorreu devido ao tempo de resposta para o download da imagem e ao tempo de processamento correspondente necessário para a imagem.
Na próxima etapa, você vai reverter o recurso e identificar como melhorar a implementação dele para reduzir o impacto no desempenho.
10. Reverter o recurso
Aumentar o tempo de espera dos usuários durante a tela de apresentação não é desejável. Um dos principais benefícios da Configuração remota é a capacidade de pausar e reverter o lançamento sem precisar lançar outra versão para os usuários. Isso permite que você reaja rapidamente a problemas, como os de desempenho que você descobriu na última etapa, e minimize o número de usuários insatisfeitos.
Como uma mitigação rápida, você redefinirá o percentil de lançamento de volta para 0
. Assim, todos os usuários verão a imagem padrão novamente:
- Volte para a página Configuração remota no Console do Firebase.
- Clique em Condições na parte de cima da página.
- Clique na condição
Seasonal image rollout
que você adicionou anteriormente. - Mude o percentil para 0%.
- Clique em Salvar condição.
- Clique em Publicar alterações e confirme as mudanças.
Reinicie o app no Android Studio. A tela principal original do estado vazio vai aparecer:
11. Corrigir os problemas de desempenho
Você descobriu anteriormente no codelab que o download de uma imagem para a tela inicial estava causando a lentidão do app. Analisando melhor a imagem transferida por download, você percebe que está usando a resolução original da imagem, que tem mais de 2 MB. Uma solução rápida para o problema de desempenho é reduzir a qualidade para uma resolução mais adequada, para que a imagem demore menos tempo para ser transferida.
Lance o valor da Configuração remota novamente
- Volte para a página Configuração remota no Console do Firebase.
- Clique no ícone Editar do parâmetro
seasonal_image_url
. - Atualize o Valor do lançamento sazonal da imagem para
https://images.unsplash.com/photo-1552691021-7043334e0b51?w=640
e clique em Salvar.
- Clique na guia Condições na parte de cima da página.
- Clique em Lançamento sazonal de imagem e defina o percentil novamente para 100%.
- Clique em Salvar condição.
- Clique no botão Publicar alterações.
12. Testar a correção e configurar alertas
Executar o app localmente
Com o novo valor de configuração definido para usar um URL de imagem de download diferente, execute o app novamente. Desta vez, o tempo gasto na tela de apresentação será menor do que antes.
Ver o desempenho das mudanças
Volte ao painel Desempenho no Console do Firebase para ver a aparência das métricas.
- Desta vez, você vai usar a tabela de rastros para navegar até a página de detalhes. Na tabela de traces, na guia Traces personalizados, clique no trace personalizado
splash_seasonal_image_processing
para conferir novamente uma visualização mais detalhada da métrica de duração.
- Clique no atributo personalizado
seasonal_image_url_attribute
para ver o detalhamento novamente. Se você passar o cursor sobre os URLs, verá um valor que corresponde ao novo URL da imagem em tamanho reduzido:https://images.unsplash.com/photo-1552691021-7043334e0b51?w=640
(com?w=640
no final). O valor de duração associado a esta imagem é consideravelmente menor do que o valor da imagem anterior e mais aceitável para os usuários.
- Agora que você melhorou o desempenho da tela inicial, é possível configurar alertas para receber notificações quando um rastro ultrapassar um limite definido por você. Abra o painel Performance e clique no ícone do menu flutuante (três pontos) de splash_screen_trace e em Configurações de alerta.
- Clique no botão para ativar o alerta Duração. Defina o valor do limite um pouco acima do mostrado. Assim, se o splash_screen_trace exceder esse valor, você receberá um e-mail.
- Clique em Salvar para criar o alerta. Role para baixo até a tabela de traces e clique na guia Traces personalizados para conferir se o alerta está ativado.
13. Parabéns!
Parabéns! Você ativou o SDK do Monitoramento de desempenho do Firebase e coletou traces para medir o desempenho de um novo recurso. Você monitorou as principais métricas de desempenho para o lançamento de um novo recurso e reagiu rapidamente quando um problema de desempenho foi descoberto. Tudo isso foi possível com a capacidade de fazer alterações de configuração com a Configuração remota e monitorar problemas de desempenho em tempo real.
O que vimos
- Adicionar o SDK do Monitoramento de desempenho do Firebase ao seu app
- Como adicionar um trace de código personalizado ao código para medir um recurso específico
- Definir um parâmetro da Configuração remota e um valor condicional para controlar/lançar um novo recurso
- Entender como usar o painel de monitoramento de desempenho para identificar problemas durante um lançamento
- Configurar alertas de desempenho para receber notificações quando a performance do app ultrapassar um limite definido