Monitorizar a utilização da API

Esta página descreve como usar as métricas de API para monitorizar e compreender a sua utilização das APIs Google e das APIs Google Cloud.

As APIs Google produzem métricas de utilização detalhadas que podem ajudar a:

  • Monitorize e compreenda a sua utilização das APIs Google.
  • Monitorize o desempenho das suas aplicações e APIs Google.
  • Descubra problemas entre as suas aplicações e as APIs Google.

Pode acelerar drasticamente os tempos de resolução quando resolve problemas ou precisa de apoio técnico da Google.

As métricas produzidas pelas APIs Google são os sinais padrão que os engenheiros de fiabilidade de sites da Google usam para avaliar o estado de funcionamento de um serviço. Estas métricas abrangem as contagens de pedidos, as taxas de erro, as latências totais, as latências de back-end, os tamanhos dos pedidos e os tamanhos das respostas. Para as definições das métricas da API, consulte a documentação do Cloud Monitoring.

Pode ver as métricas da API em dois locais: Painel de controlo da API e Cloud Monitoring. As métricas que vê são específicas do seu projeto e não refletem o estado geral do serviço.

Usar o painel de controlo da API

A forma mais simples de ver as métricas da API é usar o Painel de controlo da API da consola do Google Cloud. Pode ver uma vista geral de toda a sua utilização da API ou analisar em detalhe a sua utilização de uma API específica.

Para ver uma vista geral da utilização da API:

  1. Visite a secção APIs e serviços da Cloud Console. O painel de controlo principal da API é apresentado por predefinição. Nesta página, pode ver todas as APIs que tem atualmente ativadas para o seu projeto, bem como gráficos de vista geral para as seguintes métricas:

    • Tráfego: o número de pedidos por segundo feitos pelo seu projeto ou sobre o mesmo às APIs ativadas
    • Erros: a percentagem de pedidos às APIs ativadas que resultaram em erros
    • Latência mediana: a latência mediana para pedidos de APIs ativadas, se disponível.

Para ver detalhes de utilização de uma API específica:

  1. Selecione a API que quer ver na lista de APIs do painel de controlo da API principal. A página Vista geral da API mostra um gráfico de tráfego mais detalhado com uma discriminação por código de resposta.
  2. Para ver informações de utilização ainda mais detalhadas, selecione Ver métricas. Por predefinição, são apresentados os seguintes gráficos pré-criados, embora estejam disponíveis mais:

    • Tráfego por código de resposta
    • Erros por método da API
    • Latência geral no 50.º, 95.º e 99.º percentil
    • Latência por método da API (mediana)
  3. Se quiser adicionar mais gráficos, pode selecionar gráficos pré-criados adicionais no menu pendente Selecionar gráficos.

Usar o Cloud Monitoring

Se usar o Cloud Monitoring, pode analisar mais detalhadamente os dados das métricas disponíveis através do Explorador de métricas para ter uma melhor compreensão da sua utilização da API. O Cloud Monitoring suporta uma grande variedade de métricas que pode combinar com filtros e agregações para ter novas vistas detalhadas do desempenho da sua aplicação. Por exemplo, pode combinar uma métrica de contagem de pedidos com um filtro na classe de código de resposta HTTP para criar um painel de controlo que mostre as taxas de erro ao longo do tempo ou pode analisar a latência do percentil 95 dos pedidos à API Cloud Pub/Sub.