Mesures de la passerelle d'API

Découvrez les mesures émises par API Gateway.

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

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

Ressources : Passerelles

Aperçu des mesures du service Passerelle d'API

Les mesures du service Passerelle d'API vous permettent de mesurer les connexions aux passerelles d'API et la quantité de données reçues et envoyées par les passerelles d'API. Vous pouvez utiliser les données des mesures pour diagnostiquer et résoudre les problèmes liés aux passerelles d'API et aux déploiements d'API.

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

Pour voir les graphiques de jeux de mesures par défaut dans la console, naviguez jusqu'à la passerelle d'API qui vous intéresse, puis sélectionnez Mesures. Vous pouvez également utiliser le service Surveillance pour créer des interrogations personnalisées. Voir Création d'interrogations de mesure.

Préalables

Politiques IAM : Pour surveiller les ressources, le type d'accès requis doit vous être accordé dans une politique écrite par un administrateur, que vous utilisiez la console ou l'API REST avec une trousse SDK, l'interface de ligne de commande ou un autre outil. La politique doit vous donner accès à la fois aux services de surveillance et aux ressources surveillées. Si vous essayez d'effectuer une action et obtenez un message indiquant que vous ne disposez pas de l'autorisation requise, communiquez avec l'administrateur pour connaître le type d'accès qui vous a été octroyé et le compartiment que vous devez utiliser. Pour plus d'informations sur les autorisations d'utilisateur pour la surveillance, voir Politiques IAM.

Mesures disponibles : oci_apigateway

Les mesures indiquées dans les tableaux suivants sont automatiquement disponibles pour toutes les passerelles d'API que vous créez. Il n'est pas nécessaire d'activer la surveillance de la ressource pour obtenir ces mesures.

Les mesures du service Passerelle d'API 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 DU DÉPLOIEMENT: Nom du déploiement d'API.
ROUTE: Chemin de routage des appels d'API au service dorsal.
HTTPMETHODTYPE: Méthodes HTTP des connexions entrantes acceptées par le service dorsal (par exemple GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE: Code de statut de réponse HTTP reçu de la passerelle d'API (par exemple 200, 201, 502, 504).
HTTPSTATUSCATEGORY: Catégorie du code de statut de réponse HTTP reçu de la passerelle d'API (par exemple 2xx, 3xx, 4xx, 5xx).
NOM DU SERVEUR DORSAL: Nom de l'élément dorsal (dérivé du nom de la règle d'élément dorsal) vers lequel une passerelle d'API achemine les demandes.
BACKENDTYPE: Type d'élément dorsal vers lequel une passerelle d'API achemine les demandes vers un service dorsal (par exemple HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE: Code de statut de réponse HTTP reçu de l'élément dorsal (par exemple 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY: Catégorie du code de statut de réponse HTTP reçu de l'élément dorsal (par exemple 2xx, 3xx, 4xx, 5xx).
RESPONSECACHERESULT: Action effectuée par le cache de réponses (HIT, MISS, BYPASS).
NOM DE DROIT: Nom des droits.
ID ABONNÉ: OCID de l'abonné.
NOM D'ABONNÉ: Nom de l'abonnement.
NOM DU CLIENT: Nom du client d'un abonné.
ACTION: Action effectuée si le nombre maximal de demandes dans la période du quota du droit 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 entrantes des clients d'API à 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 d'élément dorsal	Nombre	Nombre de réponses HTTP retournées par les services dorsaux.	`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. Ce calcul est effectué à 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 la réponse est terminée. Latence est la somme des valeurs Latence d'intégration et 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 des serveurs dorsaux HTTP, OCI Functions, DNS et des serveurs d'authentification).	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	Latence interne	Secondes	Délai interne de traitement de la demande par la passerelle d'API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	Actions sur le cache de réponses	Nombre	Action effectuée par le cache de réponses.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	Disponibilité du cache de réponses	Nombre	Disponibilité du cache de réponses vue par la passerelle d'API.	`resourceId` `resourceName`
`ResponseCacheLatency`	Latence du cache de réponses	millions de secondes	Temps total nécessaire pour les opérations de connexion, lecture et stockage dans le cache de réponses.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	Demandes du plan d'utilisation	Sum	Nombre de demandes pour un droit donné. Émis par demande.	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	Demandes de l'abonné	Sum	Nombre de demandes effectuées par un abonné. Émis par demande.	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	Proportion utilisée d'un quota d'abonné	moyenne	Proportion du quota d'un droit consommé 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 d'une limite de taux d'abonné	moyenne	Proportion de la limite de taux d'un droit 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

Pour voir les graphiques de mesures par défaut pour une seule passerelle d'API

Dans la page de liste Passerelles, sélectionnez la passerelle d'API pour laquelle vous voulez voir les mesures. Si vous avez besoin d'aide pour trouver la page de liste ou la passerelle d'API, voir Liste des passerelles d'API.
Sous Ressources, sélectionnez Mesures.

La page Mesures affiche un graphique pour chaque mesure émise par l'espace de noms de mesure pour le service Passerelle d'API. Pour plus d'informations sur les mesures émises, voir Mesures disponibles : oci_apigateway.

Pour plus d'informations sur la surveillance des mesures et l'utilisation des alarmes, voir Aperçu de la surveillance. Pour plus d'informations sur les avis relatifs aux alarmes, voir Aperçu des avis.

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

Si vous ne voyez pas les données des mesures attendues pour une passerelle d'API, consultez les causes possibles suivantes et les solutions proposées.


Problème	Cause possible	Comment vérifier	Résolution
J'ai appelé une API déployée sur une passerelle d'API, mais le graphique Demandes HTTP ne montre pas l'appel d'API.	Vous avez peut-être appelé l'API en dehors de la période couverte par le graphique Demandes HTTP.	Vérifiez que l'heure de début et l'heure de fin couvrent la période pendant laquelle vous avez appelé l'API.	Ajustez l'heure de début et l'heure de fin selon les besoins.
J'ai appelé une API déployée sur une passerelle d'API, mais le graphique Demandes HTTP ne montre pas l'appel d'API, même si j'ai appelé l'API entre l'heure de début et l'heure de fin.	Bien que vous ayez appelé l'API entre l'heure de début et l'heure de fin, l'axe x (la fenêtre d'affichage des données) peut être exclu de l'appel d'API.	Vérifiez que l'axe x (la fenêtre d'affichage des données) couvre la période pendant laquelle l'API a été appelée.	Ajustez l'axe x (la fenêtre d'affichage des données) selon les besoins.
Je souhaite voir les données des graphiques sous forme d'une ligne continue sur une période, mais la ligne contient des espaces.	Ce comportement est attendu. S'il n'existe aucune donnée de mesure à montrer dans l'intervalle sélectionné, la ligne de données est discontinue.	Augmentez l'intervalle (par exemple, de 1 minute à 5 minutes ou de 1 minute à 1 heure).	Ajustez l'intervalle selon les besoins.

Pour voir les graphiques de mesures par défaut pour toutes les passerelles d'API d'un compartiment

Ouvrez le menu de navigation et sélectionnez Observabilité et gestion. Sous Surveillance, sélectionnez Mesures de service.
Sélectionnez la région que vous utilisez avec le service Passerelle d'API.
Sélectionnez le compartiment contenant les passerelles d'API pour lequel vous voulez voir des mesures.
Pour espace de noms de mesure, sélectionnez oci_apigateway.

La page Mesures de service est mise à jour de manière dynamique afin d'afficher les graphiques pour chaque mesure émise par l'espace de noms de mesure sélectionné. Pour plus d'informations sur les mesures émises, voir Mesures disponibles : oci_apigateway.

Pour plus d'informations sur la surveillance des mesures et l'utilisation des alarmes, voir Aperçu de la surveillance. Pour plus d'informations sur les avis relatifs aux alarmes, voir Aperçu des avis.

Utilisation de l'API

Pour plus d'informations sur l'utilisation de l'API et sur les demandes de signature, voir la documentation de l'API REST et Données d'identification de sécurité. Pour plus d'informations sur les trousses SDK, voir Trousses SDK et interface de ligne de commande.

Utilisez les API suivantes pour la surveillance :

API de surveillance pour les mesures et les alarmes
API d'avis pour les avis (utilisée avec les alarmes)