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

Adicionar monitoramento personalizado para código de aplicativo específico

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

O Monitoramento de Desempenho coleta rastreamentos para ajudá-lo a monitorar o desempenho do seu aplicativo. Um rastreamento é um relatório de dados de desempenho capturados entre dois pontos no tempo em seu aplicativo.

Você pode criar seus próprios rastreamentos para monitorar dados de desempenho associados a um código específico em seu aplicativo. Com um rastreamento de código personalizado , você pode medir quanto tempo seu aplicativo leva para concluir uma tarefa específica ou um conjunto de tarefas, por exemplo, carregar um conjunto de imagens ou consultar seu banco de dados.

A métrica padrão para um rastreamento de código personalizado é sua "duração" (o tempo entre os pontos inicial e final do rastreamento), mas você também pode adicionar métricas personalizadas .

Em seu código, você define o início e o fim de um rastreamento de código personalizado usando as APIs fornecidas pelo SDK do Monitoramento de desempenho.

Os rastreamentos de código personalizados podem ser iniciados a qualquer momento após a criação e são seguros para threads.

Como a métrica padrão coletada para esses rastreamentos é "duração", eles às vezes são chamados de "rastreamentos de duração".

Você pode visualizar os dados desses rastreamentos na subguia de rastreamentos personalizados da tabela de rastreamentos, que fica na parte inferior do painel Desempenho (saiba mais sobre como usar o console mais adiante nesta página).

Atributos padrão, atributos personalizados e métricas personalizadas

Para rastreamentos de código personalizados, o Monitoramento de desempenho registra automaticamente os atributos padrão (metadados comuns, como versão do aplicativo, país, dispositivo etc.) para que você possa filtrar os dados do rastreamento no console do Firebase. Você também pode adicionar e monitorar atributos personalizados (como nível de jogo ou propriedades do usuário).

Você pode configurar ainda mais um rastreamento de código personalizado para registrar métricas personalizadas para eventos relacionados ao desempenho que ocorrem no escopo do rastreamento. Por exemplo, você pode criar uma métrica personalizada para o número de acertos e erros do cache ou o número de vezes que a interface do usuário não responde por um período de tempo perceptível.

Os atributos personalizados e as métricas personalizadas são exibidos no console do Firebase junto com os atributos padrão e a métrica padrão do trace.

Adicionar rastreamentos de código personalizados

Use a API de rastreamento de monitoramento de desempenho para adicionar rastreamentos de código personalizados para monitorar o código de aplicativo específico.

Observe o seguinte:

  • Um aplicativo pode ter vários rastreamentos de código personalizados.
  • Mais de um rastreamento de código personalizado pode ser executado ao mesmo tempo.
  • Os nomes para rastreamentos de código personalizados devem atender aos seguintes requisitos: nenhum espaço em branco à esquerda ou à direita, nenhum caractere de sublinhado à esquerda ( _ ) e o comprimento máximo é de 100 caracteres.
  • Os rastreamentos de código personalizados suportam a adição de métricas personalizadas e atributos personalizados .

Para iniciar e interromper um rastreamento de código personalizado, envolva o código que você deseja rastrear com um código semelhante ao seguinte:

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

Adicionar métricas personalizadas a rastreamentos de código personalizados

Use a API de rastreamento de monitoramento de desempenho para adicionar métricas personalizadas a rastreamentos de código personalizados.

Observe o seguinte:

  • Os nomes das métricas personalizadas devem atender aos seguintes requisitos: nenhum espaço em branco à esquerda ou à direita, nenhum caractere de sublinhado à esquerda ( _ ) e o comprimento máximo é de 100 caracteres.
  • Cada rastreamento de código personalizado pode registrar até 32 métricas (incluindo a métrica de duração padrão).

Para adicionar uma métrica personalizada, adicione uma linha de código semelhante à seguinte sempre que o evento ocorrer. Por exemplo, essa métrica personalizada conta eventos relacionados ao desempenho que ocorrem em seu aplicativo, como acertos de cache ou novas tentativas.

Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();

// Code you want to trace

customTrace.incrementMetric("metric-name", 1);

// More code

await customTrace.stop();

Criar atributos personalizados para rastreamentos de código personalizados

Para usar atributos personalizados, adicione um código ao seu aplicativo que defina o atributo e o associe a um rastreamento de código personalizado específico. Você pode definir o atributo personalizado a qualquer momento entre o início e o término do rastreamento.

Observe o seguinte:

  • Os nomes para atributos personalizados devem atender aos seguintes requisitos: nenhum espaço em branco à esquerda ou à direita, nenhum caractere de sublinhado à esquerda ( _ ) e o comprimento máximo é de 32 caracteres.

  • Cada rastreamento de código personalizado pode registrar até 5 atributos personalizados.

  • Você não deve usar atributos personalizados que contenham informações que identifiquem pessoalmente um indivíduo para o Google.

Trace trace = FirebasePerformance.instance.newTrace("test_trace");

// Update scenario.
trace.putAttribute("experiment", "A");

// Reading scenario.
String? experimentValue = trace.getAttribute("experiment");

// Delete scenario.
trace.removeAttribute("experiment");

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();

Acompanhe, visualize e filtre dados de desempenho

Acompanhe métricas específicas em seu painel

Para saber quais são as tendências de suas principais métricas, adicione-as ao quadro de métricas na parte superior do painel Desempenho . Você pode identificar rapidamente as regressões vendo as alterações semanais ou verificando se as alterações recentes em seu código estão melhorando o desempenho.

Para adicionar uma métrica ao seu quadro de métricas, acesse o painel Desempenho no console do Firebase e clique na guia Painel . Clique em um cartão de métrica vazio e selecione uma métrica existente para adicionar ao seu quadro. Clique nas reticências verticais ( ) em um cartão de métrica preenchido para obter mais opções, como substituir ou remover uma métrica.

O quadro de métricas mostra os dados de métricas coletados ao longo do tempo, tanto na forma gráfica quanto como uma alteração percentual numérica.

Saiba mais sobre como usar o painel .

Visualizar rastreamentos e seus dados

Para visualizar seus rastreamentos, acesse o painel Desempenho no console do Firebase, role para baixo até a tabela de rastreamentos e clique na subguia apropriada. A tabela exibe algumas métricas principais para cada rastreamento e você pode até classificar a lista pela alteração percentual de uma métrica específica.

Se você clicar em um nome de rastreamento na tabela de rastreamentos, poderá clicar em várias telas para explorar o rastreamento e detalhar as métricas de interesse. Na maioria das páginas, você pode usar o botão Filter (canto superior esquerdo da tela) para filtrar os dados por atributo, por exemplo:

  • Filtre por versão do aplicativo para visualizar dados sobre uma versão anterior ou sua versão mais recente
  • Filtre por dispositivo para saber como os dispositivos mais antigos lidam com seu aplicativo
  • Filtre por país para garantir que o local do banco de dados não esteja afetando uma região específica

Saiba mais sobre como visualizar dados para seus rastreamentos .

Próximos passos

  • Saiba mais sobre como usar atributos para examinar dados de desempenho.

  • Saiba mais sobre como rastrear problemas de desempenho no Firebase console.

  • Configure alertas para alterações de código que estão prejudicando o desempenho do seu aplicativo. Por exemplo, você pode configurar um alerta por email para sua equipe se a duração de um rastreamento de código personalizado específico exceder um limite definido por você.