Descrições das métricas do lado do cliente

Esta página contém uma descrição detalhada de cada métrica do lado do cliente oferecida pelo Spanner. Para mais informações sobre como visualizar e gerenciar métricas do lado do cliente, consulte Visualizar e gerenciar métricas do lado do cliente.

As métricas do lado do cliente oferecem informações de latência sobre as tentativas e as operações de solicitação de RPC do cliente para o Spanner.

Uma tentativa é uma única solicitação de RPC do cliente para o Spanner. O cliente pode fazer várias tentativas se uma solicitação falhar.

Uma operação representa a conclusão de todas as solicitações de RPC, incluindo todas as tentativas que o cliente fez no Spanner. Uma operação é concluída quando o cliente recebe uma resposta ou esgota todas as tentativas.

Uma solicitação RPC chega primeiro ao Google Front End (GFE) e depois ao front-end da API Spanner (AFE). Para mais informações, consulte Pontos de latência em uma solicitação do Spanner.

O cliente calcula as métricas de latência do GFE e do AFE com base nas informações de tempo que o GFE e o AFE adicionam aos cabeçalhos de resposta. Se uma tentativa terminar antes que o cliente receba os cabeçalhos de resposta, ele não vai registrar uma amostra de latência do GFE ou do AFE para essa tentativa. Por exemplo, isso acontece quando o prazo da solicitação expira e o cliente retorna um erro DEADLINE_EXCEEDED. Em vez disso, o cliente incrementa a métrica de contagem de erros de conectividade correspondente. Como resultado, as distribuições de latência do GFE e do AFE incluem apenas tentativas que receberam cabeçalhos de resposta e podem parecer normais, mesmo quando muitas tentativas atingem o tempo limite.

O cliente registra as métricas do GFE apenas para solicitações que passam por ele. Se uma solicitação usar o DirectPath (directpath_used é true), o cliente não vai registrar a latência do GFE ou a contagem de erros de conectividade do GFE para essa solicitação.

Essas métricas incluem os tipos de valor de métrica DISTRIBUTION e INT64. Para mais informações, consulte Tipos de valor e de métricas.

É possível acessar as métricas do lado do cliente usando as bibliotecas de cliente do Spanner para Java, Go, Node.js e Python.

As métricas do lado do cliente são compatíveis com todos os métodos do Spanner na API RPC google.spanner.v1.Spanner.

Todas as métricas do lado do cliente têm as seguintes dimensões:

  • project ID: o ID do projeto do Google Cloud .
  • instance ID: o ID da instância do Spanner.
  • database ID: o ID do banco de dados do Spanner.
  • location: a região do Google Cloud em que as métricas do lado do cliente são publicadas. Se o aplicativo for implantado fora de Google Cloud, as métricas serão publicadas na região global.
  • method: o nome do método RPC, por exemplo, spanner.commit.
  • status: o status da RPC, por exemplo, OK ou INTERNAL.
  • client_name: o nome e a versão da biblioteca, por exemplo, spanner-java/6.70.1.
  • directpath_enabled: se a biblioteca de cliente está configurada para acessar diretamente o Spanner sem passar pelo front-end.
  • directpath_used: se a solicitação atual foi enviada diretamente ao Spanner sem passar pelo front-end. Um valor false enquanto directpath_enabled é true indica que a solicitação voltou para o caminho padrão que passa pelo GFE.

Contagem de erros de conectividade do AFE

A métrica de contagem de erros de conectividade do AFE registra o número de tentativas em que o cliente não recebeu informações de tempo do AFE do Spanner nos cabeçalhos de resposta. Isso acontece, por exemplo, quando a solicitação não chega ao AFE ou quando a tentativa expira antes que o cliente receba os cabeçalhos de resposta. A métrica Latências do AFE não registra uma amostra para essas tentativas.

A métrica de contagem de erros de conectividade do AFE tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/afe_connectivity_error_count
  • Metric value type: INT64

Latências de AFE

A métrica de latências do AFE mede o tempo entre o momento em que o AFE do Spanner recebe a solicitação de RPC do cliente e o momento em que o AFE do Spanner começa a gravar a resposta.

O cliente calcula esse valor com base nas informações de tempo nos cabeçalhos de resposta. Se uma tentativa terminar antes que o cliente receba cabeçalhos de resposta, o cliente não registrará uma amostra e, em vez disso, incrementará a métrica contagem de erros de conectividade do AFE.

A métrica de latências do AFE tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/afe_latencies
  • Metric value type: DISTRIBUTION

Contagem de tentativas

A métrica de contagem de tentativas registra o número de tentativas realizadas. O valor de attempt_count geralmente é idêntico ao de operation_count. Se o cliente receber erros temporários, o valor de attempt_count será a soma de todas as tentativas.

A métrica de contagem de tentativas tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/attempt_count
  • Metric value type: INT64

Latências de tentativa

A métrica de latências de tentativa mede a duração de uma única tentativa de RPC, desde o momento em que o cliente envia a solicitação até que a tentativa seja bem-sucedida ou falhe. O valor attempt_latencies geralmente é idêntico ao valor operation_latencies. Se o cliente receber erros temporários, o valor de operation_latencies será a soma de todos os valores de attempt_latencies.

A métrica de latências de tentativa tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/attempt_latencies
  • Metric value type: DISTRIBUTION

Contagem de erros de conectividade do GFE

A métrica de contagem de erros de conectividade do GFE registra o número de tentativas em que o cliente não recebeu informações de tempo do GFE nos cabeçalhos de resposta. Isso acontece, por exemplo, quando a solicitação não chega ao GFE ou quando a tentativa expira antes que o cliente receba os cabeçalhos de resposta. A métrica de latências do GFE não registra uma amostra para essas tentativas.

A métrica de contagem de erros de conectividade do GFE tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/gfe_connectivity_error_count
  • Metric value type: INT64

Latências do GFE

A métrica de latências do GFE mede o tempo entre o recebimento da solicitação RPC do cliente pelo GFE e o recebimento do primeiro byte da resposta pelo GFE. Essa métrica não inclui o tempo gasto para qualquer handshake de TCP ou TLS.

O cliente calcula esse valor com base nas informações de tempo nos cabeçalhos de resposta. Se uma tentativa terminar antes que o cliente receba os cabeçalhos de resposta, ele não registrará uma amostra e incrementará a métrica Contagem de erros de conectividade do GFE. Se a contagem de erros de conectividade do GFE aumentar, as latências do GFE que parecem normais não significam que a latência é baixa.

A métrica de latências do GFE tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/gfe_latencies
  • Metric value type: DISTRIBUTION

Contagem de operações

A métrica de contagem de operações registra o número de operações realizadas a cada 60 segundos.

A métrica de contagem de operações tem os seguintes atributos:

  • Metric name: spanner.googleapis.com/client/operation_count
  • Metric value type: INT64

Latências de operação

A métrica de latências de operação mede o tempo de ida e volta de uma operação da camada gRPC do cliente para o Spanner e de volta ao cliente.

A métrica de latências de operação tem os seguintes atributos:

  • Metric name : spanner.googleapis.com/client/operation_latencies
  • Metric value type: DISTRIBUTION

A seguir