使用 CloudWatch 指標監控 WebSocket API 執行 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 CloudWatch 指標監控 WebSocket API 執行

您可以使用 Amazon CloudWatch 指標來監控 WebSocket API。該組態與用於 REST API 的組態類似。如需更多詳細資訊,請參閱 使用 Amazon CloudWatch 指標監控 REST API 執行

WebSocket API 支援以下指標:

指標 描述
ConnectCount 傳送到 $connect 路由整合的訊息數。
MessageCount 傳送到 WebSocket API 的訊息數 (來自用戶端或傳送到用戶端)。
IntegrationError 從整合傳回 4XX/5XX 回應的請求數。
ClientError 擁有在整合受到叫用前由 API Gateway 傳回的 4XX 回應之請求數。
ExecutionError 呼叫整合時發生的錯誤。
IntegrationLatency API Gateway 將請求傳送至整合與 API Gateway 從整合接收回應之間的時間差異。受回呼和偽裝整合抑制。

您可以使用下表中的維度來篩選 API Gateway 指標。

維度 描述
ApiId 篩選具指定 API ID 之 API 的 API Gateway 指標。
ApiId、階段 篩選具指定 API ID 與階段 ID 之 API 階段的 API Gateway 指標。
ApiId、方法、資源、階段

篩選具指定 API ID、階段 ID、資源路徑和路由 ID 之 API 方法的 API Gateway 指標。

除非您已明確啟用詳細的 CloudWatch 指標,否則 API Gateway 不會傳送這類指標。您可以透過呼叫 API Gateway V2 REST API 的 UpdateStage 動作,將 detailedMetricsEnabled 屬性更新為 true。或者,您可以呼叫 update-stage AWS CLI 命令,將 DetailedMetricsEnabled 屬性更新為 true。啟用這類指標會產生您帳戶的額外費用。如需定價資訊,請參閱 Amazon CloudWatch 定價