Surveillez WebSocket l'exécution des API à l'aide de CloudWatch métriques - Amazon API Gateway

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Surveillez WebSocket l'exécution des API à l'aide de CloudWatch métriques

Vous pouvez utiliser CloudWatch les métriques Amazon pour surveiller WebSocket les API. La configuration est similaire à celle utilisée pour les API REST. Pour plus d’informations, consultez Surveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon.

Les métriques suivantes sont prises en charge pour les WebSocket API :

Métrique Description
ConnectCount Nombre de messages envoyés à l'intégration de route $connect.
MessageCount Le nombre de messages envoyés à l' WebSocket API, depuis ou vers le client.
IntegrationError Nombre de demandes qui renvoient une réponse 4XX/5XX depuis l'intégration.
ClientError Nombre de demandes pour lesquelles API Gateway renvoie une réponse 4XX avant l'invocation de l'intégration.
ExecutionError Erreurs survenues lors de l'appel de l'intégration.
IntegrationLatency Différence de temps entre l'envoi de la demande à l'intégration par API Gateway et la réception de la réponse de l'intégration par API Gateway. Supprimé pour les rappels et les intégrations fictives.

Vous pouvez utiliser les dimensions du tableau suivant pour filtrer les métriques API Gateway.

Dimension Description
ApiId Filtre les métriques API Gateway pour une API avec l'ID d'API spécifié.
ApiId, Scène Filtre les métriques API Gateway pour trouver une étape d'API portant l'ID d'API et l'ID d'étape spécifiés.
ApiId, Méthode, ressource, étape

Filtre les métriques d'API Gateway pour une méthode d'API avec l'ID d'API, l'ID d'étape, le chemin de ressource et l'ID de route spécifiés.

API Gateway n'enverra pas ces métriques à moins que vous n'ayez explicitement activé CloudWatch les métriques détaillées. Vous pouvez le faire en appelant l'UpdateStageaction de l'API REST API Gateway V2 pour mettre à jour la detailedMetricsEnabled propriété surtrue. Vous pouvez également appeler la AWS CLI commande update-stage pour mettre à jour la DetailedMetricsEnabled propriété en. true L'activation de ces métriques implique des frais supplémentaires pour votre compte. Pour plus d'informations sur les tarifs, consultez Amazon CloudWatch Pricing.