Entenda o monitoramento de desempenho do Firestore no modo Datastore

O Cloud Monitoring coleta métricas, eventos e metadados de produtos do Google Cloud. Com o Cloud Monitoring, também é possível configurar painéis personalizados e alertas de uso.

Neste documento, orientamos você no uso de métricas, no aprendizado sobre o painel de métricas personalizadas e na definição de alertas.

Recursos monitorados

Um recurso monitorado no Cloud Monitoring representa uma entidade lógica ou física, como uma máquina virtual, um banco de dados ou um aplicativo. Os recursos monitorados contêm um conjunto exclusivo de métricas que podem ser exploradas, informadas por um painel ou usadas para criar alertas. Cada recurso também tem um conjunto de rótulos, que são pares de chave-valor que contêm mais informações sobre o recurso. Os rótulos de recursos estão disponíveis para todas as métricas associadas ao recurso.

Com a API Cloud Monitoring, o desempenho do Firestore no modo Datastore é monitorado com os seguintes recursos:

Recursos Descrição Modo de banco de dados compatível
firestore.googleapis.com/Database (recomendada) Tipo de recurso monitorado que fornece detalhamentos para project, location* e database_id . O rótulo database_id será (default) para bancos de dados criados sem um nome específico. Todas as métricas compatíveis com os dois modos, exceto as seguintes métricas que não são compatíveis com o Firestore no modo Datastore:
  • document/delete_ops_count
  • document/read_ops_count
  • document/write_ops_count
datastore_request O tipo de recurso é monitorado para projetos do Datastore e não fornece detalhamento para bancos de dados.

Métricas

O Firestore está disponível em dois modos diferentes: nativo do Firestore e Firestore no modo Datastore. Para uma comparação de recursos entre esses dois modos, consulte Escolher entre os modos de banco de dados.

Para uma lista completa de métricas do Firestore no modo Datastore, consulte Métricas do Firestore no Datastore.

Métricas de ambiente de execução do serviço

As métricas serviceruntime fornecem uma visão geral de alto nível do tráfego de um projeto. Essas métricas estão disponíveis para a maioria das APIs do Google Cloud. O tipo de recurso monitorado consumed_api contém essas métricas comuns. Essas métricas são amostradas a cada 30 minutos, resultando na suavização dos dados.

Um rótulo de recurso importante para as métricas serviceruntime é method. Esse rótulo representa o método RPC subjacente chamado. O método do SDK chamado pode não ter necessariamente o mesmo nome do método RPC subjacente. O motivo é que o SDK fornece abstração da API de alto nível. No entanto, ao tentar entender como seu aplicativo interage com o Firestore, é importante entender as métricas com base no nome do método de RPC.

Se você precisa saber qual é o método RPC subjacente de um determinado método do SDK, consulte a documentação da API.

api/request_count

Essa métrica fornece a contagem de solicitações concluídas, entre protocolo(protocolo de solicitação, como http, gRPC etc.), código de resposta (código de resposta HTTP), response_code_class (classe de código de resposta, como 2xx, 4xx etc.) e grpc_status_code (código de resposta de gRPC numérico). Use essa métrica para observar a solicitação geral da API e calcular a taxa de erros.

api/request_count que retorna um código 2xx.
Figura 1. métrica api/request_count (clique para ampliar).

Na figura 1, as solicitações que retornam um código 2xx agrupado por serviço e método podem ser vistas. Os códigos 2xx são códigos de status HTTP que indicam que a solicitação foi bem-sucedida.

api/request_count que retorna um código 2xx.
Figura 2.Métrica api/request_count que retorna um código 2xx (clique para ampliar).

Na Figura 2, as confirmações agrupadas por response_code podem ser vistas. Neste exemplo, vemos apenas respostas HTTP 200, o que implica que o banco de dados está íntegro.

Use as seguintes métricas de ambiente de execução do serviço para monitorar o banco de dados.

api/request_count no tipo de recurso datastore_request

A métrica api/request_count também está disponível no tipo de recurso datastore_request com detalhamentos api_method e response_code. Em vez disso, use essa métrica para aproveitar o período de amostragem mais refinado, o que ajuda a detectar picos.

Métrica api/request_count no recurso datastore_request
Figura 3. métrica api/request_count no recurso datastore_request (clique para ampliar).
api/request_latencies

A métrica api/request_latencies fornece distribuições de latência em todas as solicitações concluídas.

O Firestore registra métricas do componente Serviço do Firestore. As métricas de latência incluem o tempo em que o Firestore recebe a solicitação até o momento em que ele termina de enviar a resposta, incluindo as interações com a camada de armazenamento. Por isso, a latência de ida e volta (RTT, na sigla em inglês) entre o cliente e o serviço do Firestore não está incluída nessas métricas.

api/request_latencies para calcular a distribuição de latência
Figura 4.api/request_latencies para calcular a distribuição de latência.
api/request_sizes e api/response_sizes

As métricas api/request_sizes e api/response_sizes, respectivamente, fornecem insights sobre os tamanhos de payload (em bytes). Isso pode ser útil para entender as cargas de trabalho de gravação que enviam grandes quantidades de dados ou consultas muito amplas e retornam payloads grandes.

Métricas api/request_sizes e api/response_sizes
Figura 5. Métricas de api/request_sizes e api/response_sizes (clique para ampliar).

Na Figura 5, é possível ver um mapa de calor dos tamanhos de resposta para o método RunQuery. Vemos que os tamanhos são estáveis, a mediana de 50 bytes e, no geral, entre 10 e 100 bytes. Os tamanhos dos payloads são sempre medidos em bytes não compactados, excluindo as sobrecargas de controle de transmissão.

Métricas de operação de entidades

Essas métricas fornecem distribuições em bytes de tamanhos de payload para leituras (pesquisas e consultas) e gravações em um banco de dados do Firestore. Os valores representam o tamanho total do payload. Por exemplo, qualquer resultado retornado por uma consulta. Essas métricas são semelhantes às api/request_sizes e api/response_sizes, com a principal diferença de que as métricas de operação da entidade oferecem uma amostragem mais granular, mas detalhamentos menos granulares.

Por exemplo, as métricas de operação de entidade usam o recurso monitorado datastore_request para que não haja detalhamento do serviço ou método.

  • entity/read_sizes: distribuição de tamanhos de entidades de leitura, agrupadas por tipo.
  • entity/write_sizes: distribuição de tamanhos de entidades gravadas, agrupados por operações.

Métricas de índice

As taxas de gravação do índice podem ser comparadas com a métrica document/write_ops_count para entender a proporção de fanout do índice.

  • index/write_count: contagem de gravações de índice.
taxa de gravação do índice em contraste com a taxa de gravação de documentos
Figura 7. A taxa de gravação do índice é diferente da taxa de gravação do documento (clique para ampliar).

Na Figura 7, veja como a taxa de gravação do índice pode ser comparada com a taxa de gravação de documentos. Neste exemplo, para cada gravação de documento, há aproximadamente seis gravações de índice, que é uma taxa de fanout de índice relativamente pequena.

Métricas de TTL

As métricas de TTL estão disponíveis para os bancos de dados nativos do Firestore e do Firestore no modo Datastore. Use essas métricas para monitorar o efeito da política de TTL aplicada.

  • entity/ttl_deletion_count: contagem total de entidades excluídas pelos serviços de TTL.
  • entity/ttl_expiration_to_deletion_delays: tempo decorrido entre a expiração de uma entidade com um TTL e o momento em que ela foi realmente excluída.

    Se os atrasos na exclusão do TTL estiverem demorando mais de 24 horas, entre em contato com o suporte.

Próximas etapas