Mesures d'API Gateway

Découvrez les mesures émises par API Gateway.

Vous pouvez surveiller l'état, la capacité et les performances des passerelles et des déploiements d'API gérés par le service API Gateway à l'aide de mesures , d'alarmes et de notifications.

Cette rubrique décrit les mesures émises par le service API Gateway dans l'espace de noms de mesure oci_apigateway.

Ressources : passerelles

Présentation des mesures du service API Gateway

Les mesures du service API Gateway vous aident à mesurer les connexions aux passerelles d'API, ainsi que la quantité de données reçue et envoyée par les passerelles d'API. Vous pouvez utiliser les données de mesure pour diagnostiquer et résoudre les problèmes liés aux passerelles d'API et aux déploiements d'API.

Alors que la fréquence varie selon la mesure, la fréquence des mesures de service par défaut est généralement de 60 secondes (c'est-à-dire, au moins un point de données publié par minute).

Pour afficher un ensemble par défaut de graphiques de mesures dans la console, accédez à la passerelle d'API qui vous intéresse, puis sélectionnez Mesures. Vous pouvez également utiliser le service Monitoring pour créer des requêtes personnalisées. Reportez-vous à Construction de requêtes de mesure.

Prérequis

Stratégies IAM : pour surveiller des ressources, vous devez vous voir accorder le type d'accès requis dans une stratégie écrite par un administrateur, que vous utilisiez la console ou l'API REST avec un kit SDK, une interface d'interface de ligne de page ou tout autre outil. La stratégie doit vous donner accès à la fois aux services de surveillance et aux ressources surveillées. Si vous essayez d'effectuer une action et qu'un message vous indique que vous n'y êtes pas autorisé, contactez l'administrateur pour savoir quel type d'accès vous a été accordé et dans quel compartiment vous devez travailler. Pour plus d'informations sur les autorisations utilisateurs liées à la surveillance, reportez-vous à Stratégies IAM.

Mesures disponibles : oci_apigateway

Les mesures répertoriées dans les tableaux suivants sont automatiquement disponibles pour toutes les passerelles d'API que vous créez. Vous n'avez pas besoin d'activer la surveillance sur la ressource pour obtenir ces mesures.

Les mesures d'API Gateway comprennent les dimensions suivantes :

RESOURCEID
OCID  de la ressource à laquelle les mesures s'appliquent.
RESOURCENAME
Nom de la ressource à laquelle les mesures s'appliquent.
DEPLOYMENTID
OCID  du déploiement d'API.
NOM DE DÉPLOIEMENT
Nom du déploiement d'API.
ROUTE
Chemin de routage des appels d'API vers le service back-end.
HTTPMETHODTYPE
Méthodes HTTP des connexions entrantes acceptées par le service back-end (comme GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE
Code de statut de réponse HTTP reçu à partir de la passerelle d'API (par exemple, 200, 201, 502, 504).
HTTPSTATUSCATEGORY
Catégorie du code de statut de réponse HTTP reçu à partir de la passerelle d'API (par exemple, 2xx, 3xx, 4xx, 5xx).
NOM DU BACK-END
Nom du back-end (dérivé du nom de la règle back-end) vers lequel une passerelle d'API achemine les demandes.
BACKENDTYPE
Type de back-end vers lequel une passerelle d'API achemine les demandes vers un service back-end (par exemple, HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE
Code de statut de réponse HTTP reçu à partir du back-end (par exemple, 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY
Catégorie du code de statut de réponse HTTP reçu à partir du back-end (par exemple, 2xx, 3xx, 4xx, 5xx).
RESPONSABLE
Action effectuée par le cache de réponses (HIT, MISS, BYPASS).
ENTITLEMENTNAME
Nom de l'habilitation.
ID ABONNÉ
OCID de l'abonné.
NOM D'ABONNÉ
Nom de l'abonné.
NOM DU CLIENT
Nom du client d'un abonné.
ACTION
Action effectuée si le nombre maximum de demandes dans la période du quota de l'habilitation a été dépassé.
ID PLAN D'UTILISATION
OCID du plan d'utilisation.
NOM DU PLAN D'UTILISATION
Nom du plan d'utilisation.
Mesure Nom d'affichage de la mesure Unité Description Dimensions
BytesReceived Octets reçus Octets Nombre d'octets reçus par la passerelle d'API à partir des clients d'API.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

BytesSent Octets envoyés Octets Nombre d'octets envoyés par la passerelle d'API aux clients d'API.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

HttpRequests Demandes d'API Nombre Nombre de demandes de client d'API entrantes vers la passerelle d'API.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

backendType

backendName

HttpResponses Réponses d'API Nombre Nombre de réponses HTTP renvoyées par la passerelle d'API.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

backendName

BackendHttpResponses Réponses de back-end Nombre Nombre de réponses HTTP renvoyées par les services back-end.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

backendName

backendHttpStatusCode

backendHttpStatusCategory

Latency Latence de passerelle Secondes Temps nécessaire au traitement d'une demande et à l'envoi de sa réponse. Il est calculé à partir du moment où la passerelle d'API reçoit le premier octet d'une demande HTTP jusqu'au moment où l'opération d'envoi de réponse est terminée.

Latence est la somme de Latence d'intégration et de Latence interne.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

IntegrationLatency Latence d'intégration Secondes

Temps passé par la passerelle d'API à appeler des intégrations externes (telles que les back-ends HTTP, OCI Functions, DNS et les serveurs d'authentification).

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

backendType

InternalLatency Latence interne Secondes Temps passé en interne dans la passerelle d'API pour traiter la demande.

resourceId

resourceName

deploymentId

deploymentName

route

httpMethodType

httpStatusCode

httpStatusCategory

ResponseCacheAction Actions du cache de réponse Nombre Action effectuée par le cache de réponses.

resourceId

resourceName

deploymentId

deploymentName

route

responseCacheResult

ResponseCacheAvailability Disponibilité du cache de réponse Nombre Disponibilité du cache de réponses telle que vue par la passerelle d'API.

resourceId

resourceName

ResponseCacheLatency Latence du cache de réponse millisecondes Temps total des opérations de connexion, de lecture et de stockage dans le cache des réponses.

resourceId

resourceName

deploymentId

deploymentName

route

UsagePlanRequests Demandes de plan d'utilisation Synthèse Nombre de demandes adressées à une habilitation donnée. Émis par demande.

resourceId

resourceName

entitlementName

subscriberId

subscriberName

clientName

action

SubscriberRequests Demandes d'abonné Synthèse Nombre de demandes effectuées par un abonné. Émis par demande.

resourceId

resourceName

clientName

usagePlanId

usagePlanName

entitlementName

action

SubscriberQuotaProportionUsed Proportion utilisée du quota d'abonnés Moyenne Proportion du quota d'une habilitation consommée par un abonné. Émis par demande.

Calculé comme suit : <current number of requests this period> / <quota for entitlement this period>

resourceId

resourceName

clientName

usagePlanId

usagePlanName

entitlementName

SubscriberRateLimitProportionUsed Proportion utilisée de la limite de débit d'abonnés Moyenne Proportion de la limite de débit d'une habilitation qui a été consommée par un abonné. Émis par demande.

Calculé comme suit : <current number of requests this period> / <rate limit for entitlement this period>

resourceId

resourceName

clientName

usagePlanId

usagePlanName

entitlementName

Utilisation de la console

Procédure d'affichage des graphiques de mesures par défaut pour une seule passerelle d'API
  1. Sur la page de liste Passerelles, sélectionnez la passerelle d'API pour laquelle visualiser les mesures. Si vous avez besoin d'aide pour rechercher la page de liste ou la passerelle d'API, reportez-vous à Liste des passerelles d'API.
  2. Sous Ressources, sélectionnez Mesures.

    La page Mesures affiche un graphique pour chaque mesure émise par l'espace de noms de mesure d'API Gateway. Pour plus d'informations sur les mesures émises, reportez-vous à Mesures disponibles : oci_apigateway.

    Pour plus d'informations sur la surveillance des mesures et l'utilisation des alarmes, reportez-vous à Présentation de Monitoring. Pour plus d'informations sur les notifications relatives aux alarmes, reportez-vous à Présentation de Notifications.

Vous ne voyez pas les données de mesure de passerelle d'API attendues ?

Si vous ne voyez pas les données de mesure d'une passerelle d'API que vous attendiez, consultez les causes possibles et les résolutions suivantes.

Problème Cause possible Vérification Résolution
J'ai appelé une API déployée sur une passerelle d'API mais le graphique Demandes HTTP n'affiche pas l'appel d'API. Vous avez peut-être appelé l'API en dehors de la période couverte par le graphique Demandes HTTP. Assurez-vous que l'heure de début et l'heure de fin couvrent la période à laquelle vous avez appelé l'API. Ajustez l'heure de début et l'heure de fin, si nécessaire.
J'ai appelé une API déployée sur une passerelle d'API mais le graphique Demandes HTTP n'affiche pas l'appel d'API, alors que j'ai appelé l'API pendant la période définie par Heure de début et Heure de fin. Même si vous avez appelé l'API pendant la période définie par Heure de début et Heure de fin, l'axe des X (fenêtre d'affichage des données) peut exclure l'appel à l'API. Assurez-vous que l'axe des X (fenêtre d'affichage des données) couvre la période où l'API a été appelée. Ajustez l'axe des X (fenêtre d'affichage des données), si nécessaire.
Je veux visualiser les données dans les graphiques sous la forme d'une courbe continue dans le temps, mais la courbe présente des interruptions. Il s'agit d'un comportement attendu. Si aucune donnée de mesure n'apparaît dans l'intervalle sélectionné, la ligne de données est interrompue. Augmentez l'intervalle (par exemple, de 1 minute à 5 minutes, ou de 1 minute à 1 heure). Ajustez l'intervalle, si nécessaire.
Procédure d'affichage des graphiques de mesures par défaut pour toutes les passerelles d'API d'un compartiment
  1. Ouvrez le menu de navigation et sélectionnez Observation et gestion. Sous Monitoring, sélectionnez Mesures de service.
  2. Sélectionnez la région que vous utilisez avec API Gateway.
  3. Sélectionnez le compartiment contenant les passerelles d'API dont vous voulez visualiser les mesures.

  4. Dans Espace de noms de mesure, sélectionnez oci_apigateway.

    La page Mesures de service est mise à jour dynamiquement et affiche les graphiques de chaque mesure émise par l'espace de noms de mesure sélectionné. Pour plus d'informations sur les mesures émises, reportez-vous à Mesures disponibles : oci_apigateway.

Pour plus d'informations sur la surveillance des mesures et l'utilisation des alarmes, reportez-vous à Présentation de Monitoring. Pour plus d'informations sur les notifications relatives aux alarmes, reportez-vous à Présentation de Notifications.