Como monitorar sua API

Nesta página, você aprende a monitorar a integridade das APIs do gateway de API usando os registros e as métricas que o gateway de API mantém automaticamente.

Quando você cria uma API, o gateway de API cria automaticamente um serviço gerenciado correspondente O nome do serviço gerenciado criado pode ser encontrado na saída do seguinte comando:

gcloud api-gateway apis describe API_ID

O nome do seu serviço é o valor do campo managedService.

Quando os usuários fazem solicitações para sua API, o gateway de API registra informações sobre solicitações e respostas. A API Gateway também rastreia três dos quatro sinais de ouro do monitoramento: latência, tráfego e erros. Essas métricas de uso e desempenho ajudam a monitorar a API.

Antes de começar

Para gerar registros e métricas para visualização, implante uma API e envie solicitações. Se você ainda não criou e implantou uma API em um gateway, veja o Guia de início rápido do gateway de API.

Visão geral da API

Quando estiver depurando um problema com o serviço ou apenas quiser garantir que tudo está funcionando bem, acesse a visão geral da API:

  1. No Console do Google Cloud, acesse a página Gateway de API > APIs do seu projeto:

    Acessar a página "APIs"

  2. Se tiver mais de uma API, clique na que você quer monitorar.

  3. Verifique se você está na guia Visão geral.

Gráficos

A página de visão geral fornece vários gráficos com algumas métricas. Assim, é possível identificar picos, quedas ou atividades inesperadas imediatamente. Use os filtros na parte superior da página para fazer o seguinte:

  • Use a lista suspensa Selecionar gráficos para exibir gráficos das métricas do seu interesse e remover aqueles que você não quer ver.
  • Ajuste o escopo dos gráficos selecionando os vários períodos. Isso ajusta o intervalo de tempo dos valores exibidos, o que também altera a granularidade dos pontos.

Tabela de métodos

Quando estiver pronto para avançar, role para baixo os gráficos para ver uma tabela com métricas para métodos individuais na API. Você pode:

  • No canto superior esquerdo da tabela, clique no ícone Filtrar tabela para selecionar opções de consulta de filtro refinadas na tabela suspensa. Adicione um OR entre cada consulta de filtro para pesquisar vários termos.
  • No canto superior direito da tabela, clique no ícone Opções de exibição da coluna para exibir uma lista suspensa. Marque as métricas relevantes e desmarque as que você não quer exibir.
  • No canto superior direito da visão geral, use o seletor de períodos para escolher um intervalo de tempo para os valores de métricas na tabela. Isso seleciona um período tanto para os gráficos como para a tabela.

Registros

Ao identificar um problema nas métricas, você pode usar a página Explorador de registros no Console do Google Cloud para ver os registros de solicitações e respostas da API.

  • Para ver registros de métodos individuais da API, clique em Ver registros na tabela.

  • Para ver os registros de todos os métodos na API, clique em Ver todos os registros no canto inferior direito.

  • Para localizar os registros do Gateway de API diretamente na página Explorador de registros:

    1. No Console do Cloud, acesse a página Explorador de registros.

      Acessar a página Explorador de registros

    2. Selecione a API produzida, SERVICE_NAME, onde SERVICE_NAME é o nome do serviço do Endpoints.

Consulte a referência dos registros do gateway de API para mais detalhes sobre a estrutura dos registros no Explorador de registros.

Saiba o que mais você pode fazer com os registros:

  • Comece a usar o Explorador de registros.
  • Exporte os registros usando o Console do Cloud. Isso permite que você faça o stream de registros para o BigQuery para ter análises adicionais, salve os registros brutos no Cloud Storage ou os envie para os tópicos de mensagens do Cloud Pub/Sub.
  • Use os Filtros de registro avançados para especificar o conjunto de entradas de registro que você quer visualizar. Por exemplo, como receber todas as solicitações com uma latência superior a 300 milissegundos.

Filtrar por um projeto de consumidor específico

Para filtrar métricas em um projeto de consumidor específico:

  1. Consiga o número do projeto do consumidor da API. Se não tiver permissão para acessar o projeto do consumidor da API, peça a alguém que tenha permissão para conseguir o número do projeto para você.

  2. No Console do Cloud, acesse a página Gateway de API > APIs do seu projeto.

    Acessar a página "APIs"

  3. No canto superior esquerdo da página Visão geral, digite o número do projeto no campo Filtrar por número do projeto.

  4. Clique em Filtrar.

As métricas na página são atualizadas para refletir o tráfego apenas do projeto especificado.

A seguir