Métricas de gateway de API

Obtenga información sobre las métricas emitidas por API Gateway.

Puede supervisar el estado, la capacidad y el rendimiento de los gateways y los despliegue de API gestionados por el servicio de gateway de API mediante las métricas, las alarmas y lasnotificaciones.

En este tema se describen las métricas emitidas por el servicio de gateway de API en el espacio de nombre de métrica oci_apigateway.

Recursos: gateways

Visión general de las métricas de servicio de gateway de API

Las métricas de servicio de gateway de API le ayudan a medir las conexiones a gateways de API y la cantidad de datos que estos envía y reciben. Puede utilizar datos de métricas para diagnosticar y solucionar problemas de gateway de API y de despliegue de API.

Aunque la frecuencia varía según la métrica, las métricas de servicio por defecto suelen tener una frecuencia de 60 segundos (es decir, al menos un punto de datos publicado por minuto).

Para ver un juego por defecto de gráficos de métricas en la consola, navegue al gateway de API en el que está interesado y, a continuación, seleccione Métricas. También puede utilizar el servicio Supervisión para crear consultas personalizadas. Consulte Compilación de consultas de métrica.

Requisitos previos

Políticas de IAM: para supervisar recursos, debe disponer del tipo necesario de acceso en una política escrita por un administrador, tanto si utiliza la consola como la API de REST con un SDK, la CLI u otra herramienta. La política debe proporcionar acceso tanto a los servicios de supervisión como a los recursos que se están supervisando. Si intenta realizar una acción y obtiene un mensaje que indique que no tiene permiso o no está autorizado, póngase en contacto con el administrador para averiguar qué tipo de acceso se le otorgó y en qué compartimento se debe trabajar. Para obtener más información sobre la autorización de usuario para la supervisión, consulte Políticas de IAM.

Métricas disponibles: oci_apigateway

Las métricas que se muestran en las siguientes tablas están disponibles automáticamente para cualquier gateway de API que cree. No es necesario activar la supervisión en el recurso para obtener estas métricas.

Las métricas de gateway de API incluyen las siguientes dimensiones:

RESOURCEID: OCID del recurso al que se aplican las métricas.
NOMBRE DE RECURSO: Nombre del recurso al que se aplican las métricas.
DEPLOYMENTID: OCID del despliegue de API.
NOMBRE DE DESPLIEGUE: Nombre del despliegue de API.
ROUTE: Ruta de acceso para llamadas de API al servicio de backend.
HTTPMETHODTYPE: Métodos HTTP de las conexiones entrantes que ha aceptado el servicio backend (como GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE: Código de estado de respuesta HTTP recibido del gateway de API (como 200, 201, 502, 504).
HTTPSTATUSCATEGORY: Categoría del código de estado de respuesta HTTP recibido del gateway de API (como 2xx, 3xx, 4xx, 5xx).
NOMBRE DE BACKEND: Nombre del backend (derivado del nombre de la regla de backend) al que un gateway de API enruta las solicitudes.
BACKENDTYPE: Tipo de backend al que un gateway de API direcciona las solicitudes a un servicio de backend (como HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE: Código de estado de respuesta HTTP recibido del backend (como 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY: Categoría del código de estado de respuesta HTTP recibido del backend (como 2xx, 3xx, 4xx, 5xx).
ENCUESTADOS: La acción realizada por la caché de respuesta (una de las acciones HIT, MISS, BYPASS).
ENTITLEMENTNAME: El nombre del derecho.
ID DE SUSCRIPTOR: OCID del suscriptor.
NOMBRE DE SUSCRIPTOR: Nombre del suscriptor.
NOMBRE DE CLIENTE: Nombre del cliente de un suscriptor.
ACCIÓN: Acción realizada si se ha superado el número máximo de solicitudes en el período de tiempo de la cuota del derecho.
PLANIDE DE USO: OCID del plan de uso.
NOMBRE DE USUARIO: Nombre del plan de uso.


Métrica	Nombre mostrado de métrica	Unidad	Descripción	Dimensiones
`BytesReceived`	Bytes recibidos	Bytes	Número de bytes recibidos por el gateway de API de los clientes de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`BytesSent`	Bytes enviados	Bytes	Número de bytes enviados por el gateway de API a los clientes de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`HttpRequests`	Solicitudes de API	recuento	Número de solicitudes de clientes de API entrantes al gateway de API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `backendType` `backendName`
`HttpResponses`	Respuestas de API	Recuento	Número de respuestas HTTP que el gateway de API ha devuelto.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName`
`BackendHttpResponses`	Respuestas de backend	Recuento	Recuento de respuestas HTTP devueltas por los servicios de backend.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName` `backendHttpStatusCode` `backendHttpStatusCategory`
`Latency`	Latencia de gateway	Segundos	Tiempo que tarda en procesarse una solicitud y en enviarse su respuesta. Se calcula a partir del momento en que el gateway de API recibe el primer byte de una solicitud HTTP hasta el momento en que finaliza la operación de envío de respuesta. Latencia es la suma de Latencia de integración y Latencia interna.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`IntegrationLatency`	Latencia de integración	Segundos	Tiempo empleado por el gateway de API que llama a integraciones externas (como backends HTTP, OCI Functions, DNS y servidores de autenticación).	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	Latencia interna	Segundos	Tiempo empleado internamente en el gateway de API para procesar la solicitud.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	Acciones de la caché de respuesta	Recuento	La acción realizada por la caché de respuesta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	Disponibilidad de la caché de respuesta	Recuento	Disponibilidad de la caché de respuesta tal y como la ve el gateway de API.	`resourceId` `resourceName`
`ResponseCacheLatency`	Latencia de la caché de respuesta	milisegundos	Tiempo total necesario para las operaciones de conexión, lectura y almacenamiento en la caché de respuesta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	Solicitudes de plan de uso	Suma	Número de solicitudes a un derecho determinado. Emitido por solicitud.	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	Solicitudes de suscriptor	Suma	Número de solicitudes realizadas por un suscriptor. Emitido por solicitud.	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	Proporción de cuota de suscriptor usada	Media	Proporción de la cuota de un derecho que ha consumido un suscriptor. Emitido por solicitud. Calculado como: `<current number of requests this period> / <quota for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`
`SubscriberRateLimitProportionUsed`	Proporción de límite de frecuencia de suscriptor usada	Media	Proporción del límite de tarifa de un derecho que ha consumido un suscriptor. Emitido por solicitud. Calculado como: `<current number of requests this period> / <rate limit for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`

Uso de la consola

Visualización de gráficos de métricas por defecto para un único gateway de API

En la página de lista Gateways, seleccione el gateway de API para el que desea ver las métricas. Si necesita ayuda para buscar la página de lista o el gateway de API, consulte Listado de gateways de API.
En Recursos, seleccione Métricas.

En la página Métricas se muestra un gráfico para cada métrica que emite el espacio de nombre para el gateway de API. Para obtener más información sobre las métricas emitidas, consulte Métricas disponibles: oci_apigateway.

Para obtener más información sobre la supervisión de métricas y el uso de alarmas, consulte Visión general de Monitoring. Para obtener más información sobre las notificaciones de alarmas, consulte Visión general de Notifications.

¿No ve los datos de métricas de gateway de API que esperaba?

Si no ve los datos de métricas de gateway de API que esperaba, consulte las siguientes causas y resoluciones posibles.


Problema	Causa posible	Cómo comprobarlo	Resolución
He llamado a una API desplegada en un gateway de API, pero el gráfico Solicitudes HTTP no muestra la llamada de API.	Puede que haya llamado a la API fuera del período de tiempo cubierto por el gráfico Solicitudes HTTP.	Confirme que la hora de inicio y la hora de finalización cubren el período en el que llamó a la API.	Ajuste la hora de inicio y la hora de finalización según sea necesario.
He llamado a una API desplegada en un gateway de API, pero el gráfico Solicitudes HTTP no muestra la llamada de API, aunque la realicé entre la hora de inicio y la hora de finalización.	A pesar de que llamara a la API entre la hora de inicio y la hora de finalización, es posible que el eje X (ventana de visualización de datos) excluya la llamada a la API.	Confirme que el eje X (ventana de visualización de datos) cubre el período en el llamó a la API.	Ajuste el eje X (la ventana de visualización de datos) según sea necesario.
Deseo ver los datos en los gráficos como una línea continua a lo largo del tiempo, pero la línea tiene huecos.	Este es el comportamiento esperado. Si no hay datos de métricas que mostrar en el intervalo seleccionado, la línea de datos es discontinua.	Aumente el intervalo (por ejemplo, de 1 minuto a 5 minutos o de 1 minuto a 1 hora).	Ajuste el intervalo según sea necesario.

Visualización de los gráficos de métricas por defecto de todos los gateways de API en un compartimento

Abra el menú de navegación y seleccione Observación y gestión. En Supervisión, seleccione Métricas de servicio.
Seleccione la región que está utilizando con el gateway de API
Seleccione el compartimento que contiene los gateways de API cuyas métricas desea ver.
Para obtener más información sobre el espacio de nombre de métrica, seleccione oci_apigateway.

La página Métricas de servicio actualiza dinámicamente la página para mostrar gráficos de cada métrica emitida por el espacio de nombre seleccionado. Para obtener más información sobre las métricas emitidas, consulte Métricas disponibles: oci_apigateway.

Para obtener más información sobre la supervisión de métricas y el uso de alarmas, consulte Visión general de Monitoring. Para obtener más información sobre las notificaciones de alarmas, consulte Visión general de Notifications.

Uso de la API

Para obtener más información sobre el uso de la API y la firma de solicitudes, consulte la documentación de la API de REST y Credenciales de seguridad. Para obtener información sobre los SDK, consulte Los SDK y la CLI.

Utilice las siguientes API de supervisión:

API de supervisión de métricas y alarmas
API denotificaciones para notificaciones (se usa con alarmas)