Surveillance de l'exécution de l'API WebSocket avec les métriques CloudWatch - 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.

Surveillance de l'exécution de l'API WebSocket avec les métriques CloudWatch

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

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

Métrique 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 une API avec 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 pas ces métriques à moins que vous n'ayez explicitement activé les métriques CloudWatch détaillées. Pour ce faire, appelez l'action UpdateStage de l'API REST d'API Gateway V2 pour mettre à jour la propriété detailedMetricsEnabled sur true. Sinon, vous pouvez appeler la commande update-stage de l’AWS CLI pour mettre à jour la propriété DetailedMetricsEnabled sur true. L'activation de ces métriques implique des frais supplémentaires pour votre compte. Pour de plus amples informations, veuillez consulter Tarification Amazon CloudWatch.