在 API Gateway 中監控 HTTP API 的 CloudWatch 指標

您可以使用 CloudWatch 來監控 API 執行，該服務會收集並處理來自 API Gateway 的原始資料，進而將這些資料轉換為便於讀取且幾近即時的指標。這些統計資料會記錄 15 個月的時間，以便您存取歷史資訊，並更清楚 Web 應用程式或服務的執行效能。根據預設，API Gateway 指標資料會自動在一分鐘內傳送給 CloudWatch。若要監控您的指標，請為您的 API 建立 CloudWatch 儀表板。如需如何建立 CloudWatch 儀表板的詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的建立 CloudWatch 儀表板。如需更多詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的什麼是 Amazon CloudWatch？。

HTTP API 支援下列指標。您也可以啟用詳細指標，將路由層級的指標寫入 Amazon CloudWatch。

指標	描述
4xx	在指定期間內擷取的用戶端錯誤數目。
5xx	在指定期間內擷取的伺服器端錯誤數目。
Count	指定期間內的 API 要求總數。
IntegrationLatency	API Gateway 將請求轉送給後端時與收到來自後端的回應時之間的時間。
Latency	API Gateway 收到來自用戶端的請求時與它將回應傳回給用戶端時之間的時間。延遲包含整合延遲與其他 API Gateway 額外負荷。
DataProcessed	處理的資料量 (以位元組為單位)。

您可以使用下表中的維度來篩選 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。或者，您可以呼叫更新階段 AWS CLI 命令，將 DetailedMetricsEnabled 屬性更新為 true。啟用這類指標會產生您帳戶的額外費用。如需定價資訊，請參閱 Amazon CloudWatch 定價。