透過 API Gateway 使用 AWS X-Ray 服務對應和追蹤檢視 - Amazon API Gateway

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

透過 API Gateway 使用 AWS X-Ray 服務對應和追蹤檢視

本節提供如何搭配 API Gateway 使用 AWS X-Ray 服務對應和追蹤檢視的詳細資訊。

範例 X-Ray 服務地圖

AWS X-Ray 服務對應會顯示 API 及其所有下游服務的相關資訊。在 API Gateway 中為 API 階段啟用 X-Ray 後,您會在服務對應中看到節點,其中包含 API Gateway 服務中所花費整體時間的相關資訊。您可以取得所選時間範圍內 API 回應時間之回應狀態和長條圖的詳細資訊。對於與 AWS 服務 (例如 AWS Lambda 和 Amazon DynamoDB) 整合的 API,您會看到更多節點提供與這些服務相關的效能指標。每個 API 階段都會有一個服務對應。

以下範例顯示名為 test 之 API xray 階段的服務對應。這個 API 已與 Lambda 授權方函數和 Lambda 後端函數進行 Lambda 整合。這些節點代表 API Gateway 服務、Lambda 服務,以及兩個 Lambda 函數。

如需服務對應結構的詳細說明,請參閱使用 X-Ray 追蹤圖

API Gateway API 階段的服務對應範例

在服務對應上放大檢視即可查看 API 階段的追蹤檢視。此追蹤可顯示有關 API 的詳細資訊 (以區段和子區段呈現)。例如,上面顯示之服務對應的追蹤包括 Lambda 服務和 Lambda 函數的區段。如需詳細資訊,請參閱AWS Lambda 和 AWS X-Ray

如果您在 X-Ray 服務對應上選擇節點或邊緣,X-Ray 主控台會顯示延遲分佈長條圖。您可以使用延遲長條圖來查看服務需要多久時間才能完成其請求。以下是先前服務對應中 API Gateway 階段的長條圖,名為 xray/test。如需延遲分佈直方圖的詳細說明,請參閱使用延遲直方圖

API Gateway API 階段的 X-Ray 直方圖

範例 X-Ray 追蹤檢視

下圖顯示為上述範例 API 產生的追蹤檢視,搭配 Lambda 後端函數和 Lambda 授權方函數。其中顯示成功的 API 方法請求,以及回應碼 200。

如需追蹤檢視的詳細說明,請參閱檢視追蹤和追蹤詳細資料

已啟用主動追蹤的 API Gateway