Como monitorar sua API

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 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 para ver uma tabela com métricas para métodos individuais na API, abaixo dos gráficos. Outras ações possíveis:

  • 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 identificar um problema nas métricas, acesse a página Visualizador 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 Visualizador de registros:

    1. No Console do Cloud, acesse a página Stackdriver > Geração de registros:

      Ir para a página Visualizador de registros

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

Consulte a referência de registros do Endpoints para saber detalhes sobre a estrutura dos registros no Visualizador de registros.

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

Filtrar por um projeto de consumidor específico

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. A chave de API precisa ter sido criada no projeto do Google Cloud do consumidor da API, já que o Endpoints a utiliza para identificar o projeto ao qual o aplicativo de chamada está associado. Para saber como restringir o acesso à API usando uma chave de API, consulte:

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 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.

Alerta

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 métricas disponíveis no Cloud Monitoring para ver as métricas que você pode usar para configurar alertas de saturação.

Para configurar alertas:

  1. Crie um espaço de trabalho para seu projeto caso ainda não tenha um. Confira se a ID do projeto com a API monitorada pelo Endpoints está associada à conta.

  2. 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.

A seguir