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

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

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

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

Métriques Description
ConnectCount Nombre de messages envoyés à l'intégration de route $connect.
MessageCount Nombre de messages envoyés à l'API WebSocket, que ce soit 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 trouver une API portant l'ID d'API spécifié.
ApiId, Stage 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, Stage, Route

Filtre les métriques API Gateway pour trouver une méthode d'API portant l'ID d'API, l'ID d'étape et l'ID de route spécifiés.

API Gateway n'envoie ces métriques que si vous avez explicitement activé des métriques CloudWatch détaillées. Pour ce faire, appelez l'action UpdateStage de l'API Gateway V2 REST API pour mettre à jour la propriété metricsEnabled sur true. L'activation de ces métriques implique des frais supplémentaires pour votre compte. Pour plus d'informations sur la tarification, consultez la section Tarification Amazon CloudWatch.