Monitorizar a sua API

OpenAPI   |  gRPC

Esta página descreve como pode monitorizar o estado das APIs que detém através dos registos e das métricas que o Cloud Endpoints mantém automaticamente para si. Quando os utilizadores fazem pedidos à sua API, o Endpoints regista informações sobre os pedidos e as respostas. Os pontos finais também monitorizam três dos quatro sinais fundamentais de monitorização: latência, tráfego e erros. Estas métricas de utilização e desempenho ajudam a monitorizar a sua API.

Antes de começar

Tem de implementar a API e enviar-lhe pedidos para gerar registos e métricas para visualização. Se ainda não tiver nada configurado, experimente o Início rápido dos Endpoints.

Vista geral da API

Quando estiver a depurar um problema com o seu serviço ou quiser garantir que tudo está a funcionar corretamente, aceda à vista geral da API:

1. Na Google Cloud consola, aceda à página Endpoints > Serviços do seu projeto:

   Aceda à página Serviços de pontos finais

2. Se tiver mais do que uma API, clique na que quer monitorizar.

3. Certifique-se de que está no separador Vista geral.

Gráficos

Na parte superior, encontram-se gráficos de algumas das métricas, para que possa detetar imediatamente quaisquer picos e quedas. Pode:

• Na parte superior direita do primeiro gráfico, use a lista pendente Selecionar gráficos para mostrar gráficos das métricas que lhe interessam e remover as que não quer ver. Cada entrada na lista pendente tem um ponto de interrogação sobre o qual pode passar o cursor do rato para ver uma descrição da métrica apresentada.

• No canto superior direito da vista geral, ajuste os gráficos selecionando um dos vários intervalos de tempo. Isto ajusta o intervalo de tempo dos valores apresentados nestes gráficos, o que também altera a granularidade dos pontos.

Tabela de métodos

Quando tiver tudo a postos para analisar mais detalhadamente, desloque a página abaixo dos gráficos para ver uma tabela com métricas para métodos individuais na sua API. Pode:

• Na parte superior direita da tabela, use a lista pendente Selecionar colunas para mostrar as métricas que lhe interessam e remover as que não quer apresentadas. As entradas aqui também têm o ponto de interrogação sobre o qual pode passar o ponteiro do rato para ver uma descrição.

• No canto superior direito da vista geral, selecione um intervalo de tempo para os valores das métricas na tabela através do selecionador de intervalo de tempo. Isto escolhe um intervalo de tempo para os gráficos e a tabela.

Registos

Quando deteta um problema nas métricas, aceda à página Explorador de registos na Google Cloud consola para ver os registos dos pedidos e das respostas da sua API.

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

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

• Para localizar registos de pontos finais diretamente na página do Explorador de registos:

  1. Na Google Cloud consola, aceda à página Stackdriver > Registo:

     Aceda à página do Explorador de registos

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

Consulte a referência dos registos de pontos finais para ver detalhes sobre a estrutura dos registos no Explorador de registos.

Saiba o que mais pode fazer com os registos:

• Comece a usar o Explorador de registos.

  Crie consultas para especificar o conjunto de entradas de registo que quer ver, como obter todos os pedidos com uma latência superior a 300 milissegundos.

• Configure e faça a gestão de destinos para encaminhar os seus registos para destinos suportados Isto permite-lhe fazer stream dos registos para o BigQuery para análise adicional, guardar os registos não processados no Cloud Storage ou enviá-los para tópicos de mensagens do Pub/Sub.

Filtre por um projeto do consumidor específico

Alfa

Esta funcionalidade está sujeita aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. As funcionalidades de pré-DG estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Para ver as métricas de um projeto de consumidor específico, os seus consumidores da API têm de enviar uma chave da API quando fazem um pedido. Uma vez que os Endpoints usam a chave da API para identificar o projeto ao qual a aplicação de chamada está associada, a chave da API tem de ter sido criada no projeto do consumidor da API.Google Cloud Para saber como restringir o acesso à sua API através de uma chave da API, consulte o artigo Restringir o acesso à API com chaves da API.

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

1. Obtenha o número do projeto do projeto do consumidor da API. Se não tiver autorização para aceder ao projeto do consumidor da API, peça a alguém que tenha autorização para obter o número do projeto por si.

2. Na Google Cloud consola, aceda à página Endpoints > Services do seu projeto.

   Aceda à página Serviços de pontos finais

3. No canto superior esquerdo da página Vista geral, introduza 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

Esta funcionalidade está sujeita aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. As funcionalidades de pré-DG estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

As métricas recolhidas pelos pontos finais também estão disponíveis no Cloud Monitoring. Pode usar o Monitoring para configurar alertas sobre a latência, o tráfego e os erros. O único sinal de ouro para o qual não pode configurar um alerta através das métricas dos Endpoints é a saturação. As métricas que tem de monitorizar para a saturação dependem da sua aplicação. Consulte a lista de métricas disponíveis no Cloud Monitoring para métricas que pode usar para configurar alertas sobre a saturação.

Para configurar alertas:

1. Na Google Cloud consola, selecione o Google Cloud projeto com a API monitorizada do Endpoints associada à conta.

   Aceda à Google Cloud consola

2. No painel de navegação, selecione Monitorização.

3. Crie uma política de alertas para configurar alertas para os sinais de ouro através do seguinte:

   • Latência

     1. Para Tipo de condição, introduza Metric Threshold.
     2. Para Tipo de recurso, introduza Produced API.
     3. Para a métrica, introduza Request latencies.
     4. Introduza o limite para o qual quer receber um alerta e siga o resto do guia de alertas.

   • Trânsito

     1. Para Tipo de condição, introduza Metric Threshold.
     2. Para Tipo de recurso, introduza Produced API.
     3. Para a métrica, introduza Request count.
     4. Introduza o limite para o qual quer receber um alerta e siga o resto do guia de alertas.

   • Erros

     1. Para Tipo de condição, introduza Metric Threshold.
     2. Para Tipo de recurso, introduza Produced API.
     3. Para a métrica, introduza Request count.
     4. Para response-code-class, introduza 5xx.
     5. Introduza o limite para o qual quer receber um alerta e siga o resto do guia de alertas.

Nota: se a sua API ainda não tiver registado uma resposta 5xx, o formulário da política de alerta não a oferece como uma classe de código de resposta.

Nota: se a restrição crítica para o seu serviço for a E/S de rede, pode usar uma das métricas dos Endpoints para configurar um alerta. Todos os registos de pontos finais estão no tipo de recurso de Produced API.

O que se segue?

• Registos de pontos finais
• Métricas de pontos finais