Visão geral do Key Visualizer

Nesta página, você terá uma visão geral da ferramenta de diagnóstico Key Visualizer para o Firestore.

O que é o Key Visualizer?

Key Visualizer é uma ferramenta que ajuda a analisar os padrões de uso do Firestore. São gerados relatórios visuais que detalham o uso com base nos documentos acessados ou nas entradas de índice gravadas ou excluídas conforme os documentos são modificados.

O Key Visualizer pode fornecer insights sobre padrões de uso em escala. Os usos do Key Visualizer incluem:

  • Solucionar problemas de desempenho. O Key Visualizer ajuda a identificar problemas de desempenho no seu banco de dados causados por pontos de acesso de chaves de índice ou documentos sequenciais ou aumentos repentinos no tráfego.
  • Entender melhor como você acessa os dados armazenados no Firestore.
  • Projetar iterativamente um modelo de dados ou melhorar o design de um modelo de dados existente. Em cada iteração, é possível verificar o Key Visualizer para identificar problemas causados pelo modelo de dados.

Para atingir essas metas, o Key Visualizer pode ajudar a concluir as seguintes tarefas:

  • Verifique se as leituras ou gravações criam pontos de acesso em intervalos de documento específicos.
  • Veja como um aumento repentino no tráfego afeta a latência.
  • Conferir se os padrões de acesso estão balanceados no banco de dados.
  • Verifique a estrutura das chaves de índice para identificar as definições que causam problemas de carregamento.
  • Use a visualização de chaves de índice para fazer previsões melhores de padrões de carga de trabalho.

Qualificação para a digitalização

Cada verificação do Key Visualizer abrange um período de duas horas. Uma verificação para um determinado período está disponível para bancos de dados com tráfego que excede 3.000 operações de documentos em um determinado minuto.

A qualificação da verificação depende completamente da atividade do banco de dados. Ele não depende da quantidade de dados ou do tipo de dados no seu banco de dados.

Verificações do Key Visualizer

A imagem a seguir mostra uma verificação do Key Visualizer. Cada verificação inclui um mapa de calor que mostra padrões de acesso ou métricas de desempenho para um grupo de chaves de documento ou chaves de índice ao longo do tempo.

Example of a Key Visualizer scan

Como compartilhar URLs de verificação

Você pode compartilhar ou adicionar o URL de uma verificação do Key Visualizer aos favoritos. O URL abrirá a mesma verificação do Key Visualizer e selecionará a mesma métrica. Esse URL é válido até que a duração dos dados de verificação expire.

Mapas de Calor

O núcleo de uma verificação do Key Visualizer é o mapa de calor, que mostra o valor de uma métrica ao longo do tempo dividido em até 1.000 buckets de chaves contíguos.

Em um mapa de calor de chaves de documento, o eixo x representa o tempo e o eixo y representa as chaves de documento. Já em um mapa de calor de chaves de índice, o eixo x representa o tempo e o eixo y representa as chaves de índice.

Cada verificação do Key Visualizer para Firestore abrange duas horas de atividade divididas em segmentos de 10 segundos.

Um valor baixo para uma métrica é considerado "frio" e aparece como uma cor escura. Um valor alto é "quente" e exibido com uma cor clara. Os valores mais altos aparecem em branco.

No mapa de calor, diferentes tipos de uso resultam em padrões visuais distintos, o que possibilita o diagnóstico rápido de problemas. Consulte Padrões de mapa de calor para chaves de documento ou Padrões de mapa de calor para chaves de índice para conferir exemplos de alguns padrões comuns.

No Key Visualizer também há ferramentas para entender os dados em cada verificação. Consulte Primeiros passos com o Key Visualizer e Como explorar mapas de calor.

buckets de chaves

O Key Visualizer divide todas as chaves no seu banco de dados em até 1.000 intervalos contíguos, com aproximadamente o mesmo número de chaves e operações em cada intervalo. Esses buckets são conhecidos como buckets de chaves.

O Key Visualizer usa o total de Ops/s de um banco de dados para dividir os buckets de chaves de modo que cada bucket capture aproximadamente o mesmo número de Ops/s com um tamanho mínimo de 50 Ops/s por intervalo de chave. Para bancos de dados com um total maior de operações por segundo, os buckets de chaves podem capturar mais de 50 operações por segundo cada. Os bancos de dados com menos de 50 operações por segundo resultam em verificações com um intervalo de chave única.

O Key Visualizer relata a maioria das métricas como médias sobre cada bucket de chaves ou como valores máximos dentro de cada bucket de chaves.

Métricas

As métricas a seguir estão disponíveis para chaves de documentos nas verificações do Key Visualizer:

Métricas Descrição
Métricas de atividade
Operações/s Número médio de operações de documentos por segundo. Aproximadamente o mesmo da soma de gravações, pesquisas e consultas por segundo. Essa métrica pode indicar quais teclas são quentes.
Operações de gravação/s Número médio de operações de documentos por segundo para gravações e exclusões.
Operações de pesquisa/segundo Número médio de operações de documentos por segundo para pesquisas.
Operações de consultas por segundo Número médio de operações de documentos por segundo para consultas.
Métricas de desempenho
Latência média de gravação Latência média para gravações e exclusões nos dados processados no bucket.
Média de latência de pesquisa Latência média para pesquisas nos dados processados no bucket.
Latência média da consulta Latência média para consultas nos dados processados no bucket.
Latência de gravação de cauda Latência máxima de gravação ou exclusão observada nos dados processados no bucket.
Latência de cauda da pesquisa Latência máxima de pesquisa observada nos dados processados no bucket.
Latência de cauda da consulta Latência máxima de consulta observada nos dados processados no bucket.

A métrica a seguir está disponível para chaves de índice nas verificações do Key Visualizer:

Métricas Descrição
Operações de gravação de índice/s Número médio de gravações de índice por segundo.

Médias de desempenho

As métricas de latência média têm uma média sobre as chaves no bucket de chaves. Como essa medição é feita na camada de armazenamento, a latência informada aqui pode ser menor que a latência total de uma chamada de API.

Limites

O Key Visualizer mostra uma série de métricas. No entanto, ele não exibe as que afetam o desempenho do Firstore. Exemplo:

  • Os problemas de rede entre seu aplicativo e o Google Cloud podem não estar visíveis. Elas podem aparecer como faixas verticais em todas as chaves no Key Visualizer, o que só fornece dicas sobre quando os problemas ocorreram.

Duração dos dados

Os dados coletados pelo Key Visualizer para Firestore são excluídos após 14 dias.

Os dados do Key Visualizer estão disponíveis para os últimos 14 dias. Por exemplo, se você iniciar o Key Visualizer em 19 de dezembro, às 12h45, o primeiro horário de início que poderá ser escolhido para um período de 2 horas será 5 de dezembro, às 13h.

Esse limite também significa que, se você adicionar aos favoritos ou compartilhar o URL de uma verificação do Key Visualizer, o URL terá uma duração máxima de 14 dias.

A seguir