Personalize a agregação de dados de solicitação de rede

O Monitoramento de desempenho do Firebase agrega automaticamente dados de solicitações de rede semelhantes para ajudar você a entender as tendências no desempenho de suas solicitações de rede.

Às vezes, porém, você precisa personalizar a forma como o Firebase agrega dados específicos de solicitação de rede para oferecer melhor suporte aos casos de uso do seu aplicativo. Fornecemos duas maneiras de personalizar a agregação de dados para solicitações de rede: agregar dados sob padrões de URL personalizados e personalizar como a taxa de sucesso é calculada .

Agregar dados em padrões de URL personalizados

Para cada solicitação, o Firebase verifica se o URL da solicitação de rede corresponde a um padrão de URL . Se o URL da solicitação corresponder a um padrão de URL, o Firebase agregará automaticamente os dados da solicitação no padrão de URL.

Você pode criar padrões de URL personalizados para monitorar padrões de URL específicos que o Firebase não está capturando com a correspondência automática de padrões de URL derivados . Por exemplo, você pode usar um padrão de URL personalizado para solucionar problemas de um URL específico ou monitorar um conjunto específico de URLs ao longo do tempo.

O Firebase exibe todos os padrões de URL (incluindo padrões de URL personalizados) e seus dados agregados na subguia Solicitações de rede da tabela de rastreamentos, que está na parte inferior do painel Desempenho do console do Firebase.

Como funciona a correspondência de padrões de URL personalizados?

O Firebase tenta corresponder URLs de solicitação a quaisquer padrões de URL personalizados configurados antes de voltar à correspondência automática de padrões de URL. Para quaisquer solicitações correspondentes a um padrão de URL personalizado, o Firebase agrega os dados das solicitações no padrão de URL personalizado.

Se o URL de uma solicitação corresponder a mais de um padrão de URL personalizado, o Firebase mapeará a solicitação somente para o padrão de URL personalizado mais específico , de acordo com a seguinte ordem de especificidade: texto simples > * > ** da esquerda para a direita no caminho . Por exemplo, uma solicitação para example.com/books/dog corresponde a dois padrões de URL personalizados:

  • example.com/books/*
  • example.com/*/dog

No entanto, o padrão example.com/books/* é o padrão de URL correspondente mais específico porque o segmento mais à esquerda books em example.com/books/* tem precedência sobre o segmento mais à esquerda * em example.com/*/dog .

Ao criar um novo padrão de URL personalizado, esteja ciente do seguinte:

  • As correspondências e os dados agregados de solicitações anteriores não são afetados pela criação de um novo padrão de URL personalizado. O Firebase não reagrega dados de solicitação retroativamente.

  • Somente solicitações futuras serão afetadas pela criação de um novo padrão de URL personalizado. Talvez seja necessário aguardar até 12 horas para que o Monitoramento de desempenho colete e agregue dados em um novo padrão de URL personalizado.

Crie um padrão de URL personalizado

Você pode criar um padrão de URL personalizado na subguia Solicitações de rede na tabela de rastreamentos, que está na parte inferior do painel Desempenho do console do Firebase.

Um membro do projeto deve ser Proprietário ou Editor para criar um novo padrão de URL personalizado; entretanto, todos os membros do projeto podem visualizar padrões de URL personalizados e seus dados agregados.

Você pode criar até 400 padrões de URL personalizados por aplicativo e até 100 padrões de URL personalizados por domínio para esse aplicativo.

Para criar um padrão de URL personalizado, comece com um nome de host, seguido de segmentos de caminho. O nome do host deve incluir um domínio válido e, opcionalmente, pode incluir o subdomínio. Use a seguinte sintaxe de segmento de caminho para criar um padrão que possa corresponder a URLs.

  • texto simples – corresponde a uma string exata
  • * — corresponde ao primeiro segmento do subdomínio ou a qualquer string em um único segmento de caminho
  • ** — corresponde a um sufixo de caminho arbitrário

A tabela a seguir descreve algumas possíveis correspondências de padrões de URL personalizados.

Para combinar... Crie um padrão de URL personalizado como... O exemplo corresponde a este padrão de URL
Um URL exato example.com/foo/baz example.com/foo/baz
Qualquer segmento de caminho único ( * ) example.com/*/baz example.com/foo/baz
example.com/bar/baz
example.com/*/*/baz example.com/foo/bar/baz
example.com/bah/qux/baz
example.com/foo/* example.com/foo/baz
example.com/foo/bar

Observação: esse padrão não corresponderá a example.com/foo .

Um sufixo de caminho arbitrário ( ** ) example.com/foo/** example.com/foo
example.com/foo/baz
example.com/foo/baz/more/segments
subdomain.example.com/foo.bar/** subdomain.example.com/foo.bar
subdomain.example.com/foo.bar/baz
subdomain.example.com/foo.bar/baz/more/segments
O primeiro segmento de subdomínio ( * ) *.example.com/foo bar.example.com/foo
baz.example.com/foo

Visualize padrões de URL personalizados e seus dados

O Firebase exibe todos os padrões de URL (incluindo padrões de URL personalizados) e seus dados agregados na subguia Solicitações de rede da tabela de rastreamentos, que está na parte inferior do painel Desempenho do console do Firebase.

Para visualizar apenas padrões de URL personalizados, selecione Padrões personalizados no menu suspenso na subguia Solicitações de rede da tabela de rastreamentos. Observe que se um padrão de URL personalizado não tiver dados agregados, ele aparecerá apenas nesta lista.

Quando o período de retenção de dados agregados em um padrão de URL termina, o Firebase exclui esses dados do padrão de URL. Se todos os dados agregados em um padrão de URL personalizado expirarem, o Firebase não excluirá o padrão de URL personalizado do Console do Firebase. Em vez disso, o Firebase continua listando padrões de URL personalizados "vazios" na lista Padrões personalizados da subguia Solicitações de rede da tabela de rastreamentos.

Remover um padrão de URL personalizado

Você pode remover padrões de URL personalizados do seu projeto. Observe que você não pode remover um padrão de URL automático.

  1. No painel Desempenho , role para baixo até a tabela de rastreamentos e selecione a subguia Solicitações de rede .

  2. Selecione Padrões personalizados no menu suspenso na subguia Solicitações de rede .

  3. Passe o mouse sobre a linha do padrão de URL personalizado que você deseja remover.

  4. Clique em na extremidade direita da linha, selecione Remover padrão personalizado e confirme a remoção na caixa de diálogo.

Ao remover um padrão de URL personalizado, esteja ciente do seguinte:

  • Quaisquer solicitações futuras serão mapeadas para o próximo padrão de URL personalizado correspondente mais específico . Se o Firebase não encontrar padrões de URL personalizados correspondentes, ele recorrerá à correspondência automática de padrões de URL .

  • As correspondências e os dados agregados de solicitações anteriores não são afetados pela remoção de um padrão de URL personalizado.

    Você ainda pode acessar um padrão de URL personalizado removido e seus dados agregados na subguia Solicitações de rede (com Todas as solicitações de rede selecionadas) até o final do período de retenção de dados aplicável. Quando todos os dados agregados no padrão de URL personalizado removido expirarem, o Firebase excluirá o padrão de URL personalizado.

  • A subguia Solicitações de rede (com Padrões personalizados selecionados) não lista nenhum padrão de URL personalizado removido.

Próximos passos

  • Configure alertas para solicitações de rede que estão prejudicando o desempenho do seu aplicativo. Por exemplo, você pode configurar um alerta por e-mail para sua equipe se o tempo de resposta para um padrão de URL específico exceder um limite definido por você.

Personalize como a taxa de sucesso é calculada

Uma das métricas que o Firebase monitora para cada solicitação de rede é a taxa de sucesso da solicitação. A taxa de sucesso é a porcentagem de respostas bem-sucedidas em comparação com o total de respostas. Essa métrica ajuda a medir falhas de rede e de servidor.

Especificamente, o Firebase conta automaticamente as solicitações de rede com um código de resposta no intervalo de 100 a 399 como respostas bem-sucedidas.

Você pode personalizar o cálculo da taxa de sucesso contando determinados códigos de erro como "respostas bem-sucedidas", além dos códigos de resposta que o Firebase conta automaticamente como bem-sucedidos.

Por exemplo, se seu aplicativo tiver uma API de endpoint de pesquisa, você poderá contar 404 respostas como "bem-sucedidas" porque são esperadas 404 respostas para um endpoint de pesquisa. Suponha que haja 100 amostras para este endpoint de pesquisa a cada hora, e 60 delas são 200 respostas e 40 delas são 404 respostas. Antes de configurar a taxa de sucesso, a taxa de sucesso será de 60%. Depois de configurar o cálculo da taxa de sucesso para contar 404 respostas como bem-sucedidas, a taxa de sucesso será de 100%.

Configurar o cálculo da taxa de sucesso

Para configurar o cálculo da taxa de sucesso para um padrão de URL de rede, você deve ter a permissão firebaseperformance.config.update . As seguintes funções incluem essa permissão necessária por padrão: Firebase Performance Admin , Firebase Quality Admin , Firebase Admin e Proprietário ou Editor do projeto .

  1. Vá para a guia Painel de monitoramento de desempenho no console do Firebase e selecione o aplicativo para o qual deseja configurar um cálculo de taxa de sucesso.
  2. Role para baixo até a tabela de rastreamentos na parte inferior da tela e selecione a guia Solicitações de rede .
  3. Encontre o padrão de URL para o qual deseja configurar o cálculo da taxa de sucesso.
  4. Na extremidade direita da linha, abra o menu flutuante ( ) e selecione Configurar taxa de sucesso .
  5. Siga as instruções na tela para selecionar os códigos de resposta que você deseja contar como códigos de resposta bem-sucedidos.