Como monitorar sua API

OpenAPI | gRPC

Nesta página você aprende a monitorar a integridade das APIs usando os registros e as métricas mantidos automaticamente pelo Cloud Endpoints. Quando os usuários fazem solicitações para a API, o Endpoints registra informações sobre as solicitações e as respostas. Ele também rastreia três dos quatro sinais dourados de monitoramento: latência, tráfego e erros. Essas métricas de uso e desempenho ajudam a monitorar a API.

Antes de começar

Você precisa implantar a API e enviar solicitações para ela a fim de gerar registros e métricas para visualização. Caso ainda não tenha feito qualquer configuração, use o guia de início rápido do Endpoints.

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 Endpoints > Serviços do seu projeto:

   Ir para a página Serviços do Endpoints

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

Na parte superior, estão os gráficos de algumas das métricas. Dessa forma, é possível identificar imediatamente quaisquer picos e quedas. Outras ações possíveis:

• No canto superior direito do primeiro gráfico, use a lista suspensa Selecionar gráficos para mostrar os gráficos das métricas de seu interesse e remover os que você não quer visualizar. Cada entrada na lista suspensa tem um ponto de interrogação no qual é possível posicionar o ponteiro do mouse para ver uma descrição da métrica exibida.

• No canto superior direito da visão geral, ajuste os gráficos selecionando os vários períodos. Isso ajusta o intervalo de tempo de valores exibidos nesses gráficos, o que também altera a granularidade pontual.

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. É possível:

• No canto superior direito da tabela, use a lista suspensa Selecionar colunas para mostrar as métricas de seu interesse e remover as que você não quer exibir. Posicione o ponteiro sobre o ponto de interrogação nas entradas para ver uma descrição delas.

• 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

Quando você identificar um problema nas métricas, acesse a página Explorador de registros no console do Google Cloud para ver os registros das 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 Endpoints diretamente na página do Explorador de registros:

  1. No console do Google Cloud, acesse a página Stackdriver > Logging:

     Acessar a página Análise de registros

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

Consulte a referência de registros do Endpoints para ver 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.

  Crie consultas para especificar o conjunto de entradas de registro que você quer conferir, como receber todas as solicitações com uma latência maior que 300 milissegundos.

• Configure e gerencie coletores para rotear os registros para destinos compatíveis. Isso permite fazer streaming de registros para o BigQuery para análise posterior, salvar os registros brutos no Cloud Storage ou enviá-los para os tópicos de mensagens do Pub/Sub.

Filtrar por um projeto de consumidor específico

Alfa

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Para ver as métricas de um projeto de consumidor específico, os clientes da API devem enviar uma chave de API ao fazer uma solicitação. Como o Endpoints usa a chave de API para identificar o projeto que está associado ao aplicativo de chamada, a chave de API precisa ter sido criada no projeto do Google Cloud do cliente da API. Para saber como restringir o acesso à API usando uma chave de API, consulte Como restringir o acesso à API com as chaves de API.

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 Google Cloud, acesse a página Endpoints > Serviços do seu projeto.

   Ir para a página Serviços do Endpoints

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.

Alertas

Beta

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

As métricas coletadas pelo Endpoints também estão disponíveis no Cloud Monitoring. O Monitoring pode ser usado para configurar alertas sobre latência, tráfego e erros. O único sinal dourado que não pode ter um alerta configurado para usar métricas do Endpoints é a saturação. As métricas de que você precisa para monitorar a saturação dependem do seu aplicativo. Acesse a lista de metrics disponíveis no Cloud Monitoring para ver as métricas que você pode usar para configurar alertas de saturação.

Para configurar alertas:

1. No console do Google Cloud, selecione o projeto do Google Cloud com a API monitorada pelo Endpoints que está associada à conta.

   Acessar o Console do Google Cloud

2. Usando o painel de navegação, selecione Monitoramento.

3. Crie uma política de alertas para configurar alertas para os sinais dourados usando os seguintes dados:

   • Latência

     1. Para o Tipo de condição, insira Metric Threshold.
     2. Para o Tipo de recurso, insira Produced API.
     3. Para a métrica, insira Request latencies.
     4. Digite o limite para definição de alertas e siga as demais instruções do Guia de alertas.

   • Tráfego

     1. Para o Tipo de condição, insira Metric Threshold.
     2. Para o Tipo de recurso, insira Produced API.
     3. Para a métrica, insira Request count.
     4. Digite o limite para definição de alertas e siga as demais instruções do Guia de alertas.

   • Erros

     1. Para o Tipo de condição, insira Metric Threshold.
     2. Para o Tipo de recurso, insira Produced API.
     3. Para a métrica, insira Request count.
     4. Para a classe de código de resposta, insira 5xx.
     5. Digite o limite para definição de alertas e siga as demais instruções do Guia de alertas.

Observação: se sua API ainda não registrou uma resposta 5xx, o formulário da política de alertas não a oferecerá como uma classe de código de resposta.

Observação: se a restrição crítica do seu serviço for IO de rede, é possível usar uma das métricas do Endpoints para configurar um alerta. Todos os registros do Endpoints estão no Tipo de recurso de Produced API.

A seguir

• Registros do Endpoints
• Métricas do Endpoints