O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Adicionar monitoramento personalizado para códigos específicos de aplicativo

O monitoramento de desempenho coleta traces para ajudar você a monitorar o desempenho do seu app. Um trace é um relatório de dados de desempenho capturado entre dois pontos no app.

É possível criar seus próprios traces para monitorar dados de desempenho associados a um código específico no seu app. Com um trace de código personalizado, você consegue medir o tempo que o app leva para concluir uma tarefa ou um conjunto de tarefas específicas, por exemplo, 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" dele (o tempo entre os pontos inicial e de interrupção do trace), mas também é possível adicionar métricas personalizadas.

No seu código, defina o início e o fim de um trace de código personalizado usando as APIs fornecidas pelo SDK do Monitoramento de desempenho. Os traces de código personalizado também podem ser iniciados depois de ser criados e são seguros para linha de execução.

Veja dados de traces de código personalizado na guia No dispositivo do Console do Firebase (saiba mais nesta página, mais adiante). Como a métrica padrão coletada para esses traces é "duração", às vezes eles são chamados de "traces de duração". Além disso, no Console do Firebase (na guia No dispositivo), esses traces são agrupados na tabela etiquetada Durações.

Atributos padrão e atributos e métricas personalizadas

Em relação a traces de código personalizado, o Monitoramento de desempenho registra automaticamente os atributos padrão (metadados comuns, como versão do app, país, dispositivo etc.) para que você possa filtrar os dados do trace no Console do Firebase. Também é possível adicionar e monitorar atributos personalizados, como fases de jogos ou propriedades de usuários.

É possível configurar um trace de código personalizado para registrar métricas personalizadas de eventos relacionados ao desempenho que ocorrem no escopo do trace. Por exemplo, é possível criar uma métrica personalizada para o número de ausências e ocorrências em cache ou para o número de vezes que a IU não responde durante um período considerável.

Os atributos e as métricas personalizadas são exibidos no Console do Firebase ao lado dos atributos padrão e da métrica padrão do trace.

Adicionar traces de código personalizado

Use a API Trace do Monitoramento de desempenho (Swift | Obj-C) para adicionar traces de código personalizado e, assim, monitorar o código específico do aplicativo.

Observações:

  • Um app pode ter vários traces de código personalizados.
  • Mais de um trace de código personalizado pode ser executado ao mesmo tempo.
  • Os nomes dos traces de código personalizados precisam atender aos seguintes requisitos: não ter espaço em branco no início ou no fim, não ter caractere sublinhado (_) no início e ter, no máximo, 100 caracteres.
  • Os traces de código personalizados aceitam a adição de métricas personalizadas e atributos personalizados.

Para iniciar e interromper um trace de código personalizado, una o código que você quer rastrear com linhas de código semelhantes às seguintes:

Swift

// Add the Performance Monitoring module to your header
import FirebasePerformance

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

// code that you want to trace

trace.stop()

Objective-C

// Add the Performance Monitoring module to your header
@import FirebasePerformance;

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

// code that you want to trace

[trace stop];

Adicionar métricas personalizadas aos traces de código personalizados

Use a API Trace do Monitoramento de desempenho (Swift | Obj-C) para adicionar métricas personalizadas aos traces de código personalizado.

Observações:

  • Os nomes das métricas personalizadas precisam atender aos seguintes requisitos: não ter espaço em branco no início ou no fim, não ter caractere sublinhado no início (_) e ter, no máximo, 100 caracteres.
  • Cada trace de código personalizado pode registrar até 32 métricas, incluindo a métrica Duração padrão.

Para incluir uma métrica personalizada, adicione uma linha de código semelhante às seguintes toda vez que o evento ocorrer. Por exemplo, essa métrica personalizada conta eventos relacionados ao desempenho que ocorrem no app, como ocorrências em cache ou novas tentativas.

Swift

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.incrementMetric(named:"EVENT_NAME", by: 1)
// code that you want to trace (and log custom metrics)

trace.stop()

Objective-C

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace incrementMetric:@"EVENT_NAME" by:1];
// code that you want to trace (and log custom metrics)

[trace stop];

Criar atributos personalizados para traces de código personalizado

Use a API Trace do Monitoramento de desempenho (Swift | Obj-C) para adicionar atributos personalizados aos traces de código personalizado.

Para usar atributos personalizados, adicione códigos ao seu app que definam o atributo e o associem a um trace de código personalizado específico. É possível definir o atributo personalizado a qualquer momento entre o início e a interrupção do trace.

Observações:

  • Os nomes dos atributos personalizados precisam atender aos seguintes requisitos: não ter espaço em branco no início ou no fim, não ter caractere sublinhado no início (_) e ter, no máximo, 32 caracteres.

  • Cada trace de código personalizado pode registrar até cinco atributos personalizados.

  • Não use atributos personalizados que contenham informações que identifiquem um indivíduo para o Google.

    Saiba mais sobre essa diretriz

Swift

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.setValue("A", forAttribute: "experiment")

// Update scenario.
trace.setValue("B", forAttribute: "experiment")

// Reading scenario.
let experimentValue:String? = trace.valueForAttribute("experiment")

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

// Read attributes.
let attributes:[String, String] = trace.attributes;

Objective-C

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace setValue:@"A" forAttribute:@"experiment"];

// Update scenario.
[trace setValue:@"B" forAttribute:@"experiment"];

// Reading scenario.
NSString *experimentValue = [trace valueForAttribute:@"experiment"];

// Delete scenario.
[trace removeAttribute:@"experiment"];

// Read attributes.
NSDictionary <NSString *, NSString *> *attributes = [trace attributes];

Acompanhar, visualizar e filtrar dados de desempenho

Acompanhar métricas específicas no painel

Adicione as principais métricas no painel para saber qual é a situação atual delas. É possível identificar rapidamente as regressões vendo alterações semanais ou verificar se as mudanças recentes no código estão melhorando o desempenho.

Uma imagem do painel de métricas do Monitoramento de desempenho do Firebase

Para adicionar uma métrica ao painel, acesse o painel Desempenho no Console do Firebase e clique na guia Painel. Clique em um card de métricas vazio e selecione uma métrica atual para adicionar ao painel. Clique em em um card de métricas preenchido para ver mais opções, como substituir ou remover uma métrica.

O painel mostra dados de métricas coletados ao longo do tempo de duas formas: representação gráfica e porcentagem relacionada à mudança.

Saiba mais sobre como usar o painel.

Visualizar todos os traces e os respectivos dados

Para visualizar esses traces, acesse o painel Desempenho no Console do Firebase e clique na guia No dispositivo.

Na guia No dispositivo, é possível clicar em várias telas para explorar um trace e detalhar as métricas de interesse. Na maioria das páginas, é possível usar o botão Filtrar (no canto superior esquerdo da tela) para filtrar os dados por atributo, por exemplo:

Uma imagem dos dados do Monitoramento de desempenho do Firebase sendo filtrados por atributo
  • Filtrar por Versão do app para visualizar dados de uma versão anterior ou da versão mais recente.
  • Filtrar por Dispositivo para saber como os dispositivos mais antigos lidam com seu app.
  • Filtrar por País para garantir que o local do banco de dados não está afetando uma região específica.

Saiba mais sobre como visualizar dados dos traces.

Próximas etapas

  • Confira os relatórios detalhados das sessões dos usuários em que é possível ver um trace específico em uma linha do tempo com outros traces coletados durante a mesma sessão.