全部產品
Search
文件中心

API Gateway:API可觀測

更新時間:Dec 19, 2024

本文旨在為您介紹原API Gateway的可觀測能力。包括API調用日誌、API監控和警示、以及配置Trace鏈路追蹤,這些功能確保您能夠全面瞭解和監控API的運行狀態,提升系統穩定性和效能最佳化的能力。

API調用日誌

原API Gateway調用日誌,包括以下內容:

  • 通過Log Service查看API調用日誌

    API Gateway和Log Service實現無縫整合,通過Log Service您可以進行即時日誌查詢、下載、多維度統計分析等。詳細內容包括:

    • 日誌線上查詢:可根據日誌中任意關鍵字進行快速的精確、模糊檢索,可用於問題定位或者統計查詢。

    • 詳細調用日誌:您可以檢索API調用的詳細日誌包含如下表所示欄位。

    • 使用Log Service查看API日誌:您可通過Log Service來查看API Gateway的調用日誌。

  • 配置記錄HTTP請求應答日誌

    您可設定記錄API Gateway接收到的HTTP請求以及返回給用戶端的HTTP應答。

    說明

    此功能僅支援專享執行個體。

具體詳情,請參見API調用日誌

API監控和警示

原API Gateway的監控和警示,包括以下內容:

  • API Gateway監控

    API Gateway的監控支援查看region(地區)、分組、以及API的監控圖表,詳細內容包括:

    • Region監控

    • 執行個體監控(僅專享執行個體)

    • 分組監控

    • API監控

  • API警示設定

    您可以通過CloudMonitor對發布在API Gateway上的API配置警示,以便隨時瞭解API服務運行情況,保障其穩定性和可靠性。

  • 如何配置出訪串連池警示

    Log Service支援根據定義的檢查頻率、觸發條件等配置警示規則,並在滿足條件時觸發警示,可以使用Log Service來進行警示。

    當出訪串連池不夠用時,API Gateway就會給用戶端返回Backend service connect failed `Connection lease request time out`。這個報錯記錄在日誌中的errorMessage欄位中,我們可以根據這個報錯資訊來配置警示,配置文檔可參考快速設定日誌警示

具體詳情,請參見API監控和警示

配置Trace鏈路追蹤

重要

本功能僅支援專享執行個體。

您可在API Gateway控制台配置Trace鏈路追蹤,將日誌上傳到阿里雲鏈路追蹤平台。Tracing Analysis提供了全面的調用鏈路還原、請求量統計、鏈路拓撲和應用依賴等分析工具,能夠顯著提升使用者的開發診斷效率。包含以下內容:

  • 鏈路追蹤如何授權。

  • API Gateway如何配置Trace鏈路追蹤。

具體詳情,請參見配置Trace鏈路追蹤