Métricas do Serviço API Gateway

Saiba mais sobre as métricas emitidas pelo Gateway de API.

Você pode monitorar a integridade, a capacidade e o desempenho de gateways de API e implantações de API gerenciados pelo serviço API Gateway usando métricas, alarmes enotificações.

Este tópico descreve as métricas emitidas pelo serviço API Gateway no namespace de métricas oci_apigateway.

Recursos: gateways

Visão Geral das Métricas do Serviço API Gateway

As métricas dO serviço API Gateway ajudam a medir as conexões com os gateways de API e a quantidade de dados recebidos e enviados pelos gateways de API. Você pode usar dados de métrica para diagnosticar e solucionar problemas de implantação do gateway de API e da própria API.

Embora a frequência varie por métrica, as métricas de serviço padrão geralmente têm uma frequência de 60 segundos (ou seja, pelo menos um ponto de dados publicado por minuto).

Para exibir um conjunto padrão de gráficos de métricas na Console, navegue até o gateway de API em que você está interessado e selecione Métricas. Você também pode usar o serviço Monitoring para criar consultas personalizadas. Consulte Criando Consultas de Métricas.

Pré-requisitos

Políticas do IAM: Para monitorar recursos, você deve receber o tipo necessário de acesso em uma política gravada por um administrador, quer você esteja usando a Console ou a API REST com um SDK, uma CLI ou outra ferramenta. A política deve conceder acesso aos serviços e aos recursos de monitoramento. Se você tentar executar uma ação e receber uma mensagem de que não tem permissão ou que não está autorizado, entre em contato com o administrador para descobrir em qual tipo de acesso você recebeu e em qual compartimento você precisa trabalhar. Para obter mais informações sobre autorizações de usuário para monitoramento, consulte Políticas do IAM.

Métricas Disponíveis: oci_apigateway

As métricas listadas nas tabelas a seguir estão automaticamente disponíveis para qualquer gateway de API criado. Você não precisa ativar o monitoramento no recurso para obter essas métricas.

As métricas do serviço API Gateway incluem as seguintes dimensões:

RESOURCEID: O OCID do recurso ao qual as métricas se aplicam.
NOME DO RECURSO: O nome do recurso ao qual as métricas se aplicam.
DEPLOYMENTID: O OCID da implantação da API.
DEPLOYMENTNAME: O nome da implantação de API.
ROUTE: O caminho de roteamento para chamadas de API para o serviço de back-end.
HTTPMETHODTYPE: Os métodos HTTP de conexões de entrada aceitas pelo serviço de back-end (como GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE: O código de status de resposta HTTP recebido do gateway de API (como 200, 201, 502, 504).
HTTPSTATUSCATEGORY: A categoria do código de status de resposta HTTP recebido do gateway de API (como 2xx, 3xx, 4xx, 5xx).
NOME DO BACKEND: O nome do back-end (derivado do nome da regra de back-end) para o qual um gateway de API roteia solicitações.
BACKENDTYPE: O tipo de backend para o qual um gateway de API roteia solicitações para um serviço de back-end (como HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE: O código de status da resposta HTTP recebido do back-end (como 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY: A categoria do código de status de resposta HTTP recebido do back-end (como 2xx, 3xx, 4xx, 5xx).
RESULTADOS DO PROFESSOR: A ação executada pelo cache de resposta (um de HIT, MISS, BYPASS).
ENTITLEMENTNAME: O nome do direito.
ID DO ASSINANTE: O OCID do assinante.
NOME DO ASSINANTE: O nome do assinante.
CLIENTNAME: O nome do cliente de um assinante.
AÇÃO: A ação tomada se o número máximo de solicitações no período de tempo da cota do direito foi excedido.
PLANETA DE USO: O OCID do plano de uso.
NOME DO PLANO DE USO: O nome do plano de uso.


Métrica	Nome para Exibição da Métrica	Unidade	Descrição	Dimensões
`BytesReceived`	Bytes Recebidos	Bytes	Número de bytes recebidos pelo gateway de API de clientes de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`BytesSent`	Bytes Enviados	Bytes	Número de bytes enviados pelo gateway de API para clientes de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`HttpRequests`	Solicitações de API	contagem	Número de solicitações de cliente de API recebidas para o gateway de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `backendType` `backendName`
`HttpResponses`	Respostas da API	Contagem	O número de respostas http que o gateway de API enviou de volta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName`
`BackendHttpResponses`	Respostas de Back-end	Contagem	Contagem das respostas HTTP retornadas pelos serviços de back-end.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName` `backendHttpStatusCode` `backendHttpStatusCategory`
`Latency`	Latência do Gateway	Segundos	O tempo necessário para que uma solicitação seja processada e sua resposta seja enviada. Ele é calculado a partir do momento em que o gateway de API recebe o primeiro byte de uma solicitação HTTP até o momento em que a operação de envio da resposta é concluída. Latência é a soma da Latência de Integração e da Latência Interna.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`IntegrationLatency`	Latência de Integração	Segundos	Tempo gasto pelo gateway de API chamando integrações externas (como backends HTTP, Funções do OCI, DNS e servidores de autenticação).	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	Latência Interna	Segundos	Tempo gasto internamente no gateway de API para processar a solicitação.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	Ações do Cache de Resposta	Contagem	A ação executada pelo cache de resposta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	Disponibilidade do Cache de Resposta	Contagem	Disponibilidade do cache de resposta conforme visto pelo gateway de API.	`resourceId` `resourceName`
`ResponseCacheLatency`	Latência do Cache de Resposta	Milissegundos	Tempo total gasto para conectar, ler e armazenar operações no cache de resposta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	Solicitações do Plano de Uso	Sum	Número de solicitações a um determinado direito. Emitido por solicitação.	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	Solicitações do Assinante	Sum	Número de solicitações feitas por um assinante. Emitido por solicitação.	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	Proporção de Cota do Assinante Usada	Médio	Proporção da cota de um direito que foi consumida por um assinante. Emitido por solicitação. Calculado como: `<current number of requests this period> / <quota for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`
`SubscriberRateLimitProportionUsed`	Proporção de Limite de Taxa de Direitos Usado	Médio	Proporção do limite de taxa de um direito que foi consumido por um assinante. Emitido por solicitação. Calculado como: `<current number of requests this period> / <rate limit for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`

Usando a Console

Para exibir gráficos de métrica padrão para um único gateway de API

Na página da lista Gateways, selecione o gateway de API cujas métricas você deseja exibir. Se precisar de ajuda para localizar a página da lista ou o gateway de API, consulte Listando Gateways de API.
Em Recursos, selecione Métricas.

A página Métricas exibe um gráfico para cada métrica emitida pelo namespace de métricas para o serviço API Gateway. Para obter mais informações sobre as métricas emitidas, consulte Métricas Disponíveis: oci_apigateway.

Para obter mais informações sobre o monitoramento de métricas e o uso de alarmes, consulte Visão Geral do Serviço Monitoring. Para obter informações sobre notificações de alarmes, consulte Visão Geral do Serviço Notifications.

Não está visualizando os dados métricos do gateway de API que você espera?

Se você não vir os dados de métricas esperados para um gateway de API, consulte as possíveis causas e soluções a seguir.


Problema	Possível Causa	Como verificar	Solução
Eu chamei uma API implantada em um gateway de API, mas o gráfico Solicitações HTTP não mostra a chamada de API.	Você pode ter chamado API fora do período coberto pelo gráfico Solicitações HTTP.	Confirme se oHorário Inicial e o Horário Final cobrem o período em que você chamou a API.	Ajuste o Horário Inicial e o Horário Final conforme necessário.
Chamei uma API implantada em um gateway de API, mas o gráfico Solicitações HTTP não mostra a chamada de API, mesmo que eu tenha chamado a API entre o Horário Inicial e o Horário Final.	Embora você tenha chamado a API entre o Horário Inicial e o Horário Final, o eixo x (janela de exibição de dados) pode estar excluindo a chamada de API.	Confirme se o eixo x (janela de exibição de dados) abrange o período em que a API foi chamada.	Ajuste o eixo x (janela de exibição de dados) conforme necessário.
Quero ver dados nos gráficos como uma linha contínua ao longo do tempo, mas a linha tem lacunas.	Esse é o comportamento esperado. Se não houver dados de métricas para mostrar no intervalo selecionado, a linha de dados será descontínua.	Aumente o Intervalo (por exemplo, de 1 minuto para 5 minutos ou de 1 minuto para 1 hora).	Ajuste o Intervalo conforme necessário.

Para exibir gráficos de métrica padrão para todos os gateways de API em um compartimento

Abra o menu de navegação e selecione Observabilidade e Gerenciamento. Em Monitoramento, selecione Métricas do Serviço.
Selecione a região que você está usando com o serviço API Gateway
Selecione o compartimento que contém os gateways de API cujas métricas você deseja exibir.
Para Namespace de métricas, selecione oci_apigateway.

A página Métricas do Serviço atualiza dinamicamente a página para mostrar gráficos para cada métrica emitida pelo namespace de métrica selecionado. Para obter mais informações sobre as métricas emitidas, consulte Métricas Disponíveis: oci_apigateway.

Para obter mais informações sobre o monitoramento de métricas e o uso de alarmes, consulte Visão Geral do Serviço Monitoring. Para obter informações sobre notificações de alarmes, consulte Visão Geral do Serviço Notifications.

Usando a API

Para obter informações sobre como usar a API e assinar solicitações, consulte a documentação da API REST e Credenciais de Segurança. Para obter informações sobre SDKs, consulte SDKs e a CLI.

Use as seguintes APIs para monitoramento:

API Monitoring para métricas e alarmes
API Notifications para notificações (usada com alarmes)