共用方式為

監視 APIM

適用於：所有 APIM 層

Azure 監視器會收集並彙總來自系統的計量和記錄，以監視可用性、效能和復原能力，並通知您影響系統的問題。 您可以使用 Azure 入口網站、PowerShell、Azure CLI、REST API 或用戶端程式庫來設定及檢視監視資料。

不同的計量和記錄適用於不同的資源類型。 本文說明您可以為此服務收集的監視資料類型以及分析該資料的方式。

使用 Azure 監視器收集資料

下表說明如何收集資料來監視您的服務，以及收集到後的資料可以用於哪些動作：

要收集的資料 描述 如何收集和路由傳送資料 檢視資料的位置 支援的資料
計量資料 計量是描述特定時間點的系統某個方面的數值。 您可使用演算法來彙總計量、與其他計量進行比較，並分析一段時間內的趨勢。 - 定期自動收集。
- 您可以將某些平台計量路由傳送至 Log Analytics 工作區，以其他資料進行查詢。 檢查每個計量的 DS 匯出設定，以了解是否可以使用診斷設定來路由傳送計量資料。		 計量瀏覽器 Azure 監視器支援的 Azure APIM 計量 (部分內容可能是機器或 AI 翻譯)
資源記錄資料 記錄是具有時間戳記的記錄系統事件。 記錄可以包含不同類型的資料，而且可以是結構化或自由格式的文字。 您可以將資源記錄資料路由傳送至 Log Analytics 工作區以進行查詢和分析。 建立診斷設定以收集和路由傳送資源記錄資料。 Log Analytics Azure 監視器支援的 Azure APIM 資源記錄資料 (部分內容可能是機器或 AI 翻譯)
活動記錄資料 Azure 監視器活動記錄可提供訂閱層級事件的見解。 此活動記錄包含像是何時修改資源或啟動虛擬機器的資訊。 - 自動收集。
- 免費對 Log Analytics 工作區建立診斷設定。		 活動記錄檔

如需 Azure 監視器所支援之所有資料的清單，請參閱：

APIM 內建監視功能

Azure APIM 具有下列內建的監視功能。

取得 Azure API 管理中的 API 分析

Azure API 管理會為您的 API 提供分析，讓您可以分析其使用量和效能。 使用分析進行 API 的高階監視和疑難排解。 如需其他監視功能 (包括診斷和稽核的近乎即時計量和資源記錄)，請參閱教學課程：監視已發佈的 API。

入口網站中 API 分析的螢幕擷取畫面。

附註

目前，此功能無法在工作區中使用。

  • API 管理會使用以 Azure 監視器為基礎的儀表板來提供分析。 儀表板會彙總 Azure Log Analytics 工作區中的資料。
  • 在傳統 APIM 服務層級中，您的 API 管理執行個體也包含 Azure 入口網站中的舊版內建分析，而且可以使用 API 管理 REST API 來存取分析資料。 以 Azure 監視器為基礎的儀表板和內建分析中會顯示極為類似的資料。

重要事項

  • 以 Azure 監視器為基礎的儀表板是存取分析資料的建議方式。
  • 自 2027 年 3 月起，與傳統層中 API 管理 內建分析相關聯的儀錶板和報表將會 淘汰。 建議您轉換至取代它的 Azure 監視器型儀錶板。

使用 API 分析，分析跨數個維度的 API 管理執行個體中的 API 使用量和效能，包括：

  • 時程表
  • [地理位置]
  • API
  • API 作業
  • Products
  • 訂用帳戶
  • 使用者
  • Requests
  • 語言模型 (適用於大型語言模型 API)

API 分析提供有關要求的資料，包括失敗和未經授權的要求。 地理位置值是根據 IP 位址對應的值。 分析資料的可用性可能會延遲。

以 Azure 監視器為基礎的儀表板

若要使用以 Azure 監視器為基礎的儀表板，您需要 Log Analytics 工作區作為 APIM 閘道記錄的資料來源。

如果您需要設定一個，以下是將閘道記錄傳送至 Log Analytics 工作區的簡短步驟。 如需詳細資訊，請參閱本文稍後的啟用 Azure 監視器記錄的診斷設定 (部分內容可能是機器或 AI 翻譯)。 此程序為一次性設定。

  1. 在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。

  2. 在左側功能表的 [監視] 底下，選取 [診斷設定]> [+ 新增診斷設定]。

  3. 輸入診斷設定的描述性名稱。

  4. 在 [記錄] 中，選取 [與 ApiManagement 閘道相關的記錄]。

    小提示

    若要收集大型語言模型 (LLM) API 的記錄，以顯示在以 Azure 監視器為基礎的儀表板上，也請選取 [生成式 AI 閘道的相關記錄]。

  5. 在 [目的地詳細資料] 中，選取 [傳送至 Log Analytics]，然後選取相同或不同訂用帳戶中的 Log Analytics 工作區。 如果您需要建立工作區，請參閱建立 Log Analytics 工作區。

  6. 請確保已選取 [資源特定] 作為目的地資料表。

  7. 選取 [儲存]。

重要事項

新的 Log Analytics 工作區最多可能需要 2 小時才能開始接收資料。 現有的工作區應該會在大約 15 分鐘內開始接收資料。

存取儀表板

設定 Log Analytics 工作區之後，請存取以 Azure 監視器為基礎的儀表板，以分析 API 的使用量和效能。

  1. 在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。
  2. 在左側功能表的 [監視] 下，選取 [分析]。 分析儀表板隨即開啟。
  3. 選取資料的時間範圍。
  4. 選取分析資料的報表類別，例如 [時間表]、[地理位置] 等等。

舊版內建分析

在某些 APIM 服務層級中，Azure 入口網站中也提供內建分析 (也稱為舊版分析或傳統分析)，而且可以使用 API 管理 REST API 來存取分析資料。

若要存取 Azure 入口網站中的內建 (傳統) 分析：

  1. 在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。
  2. 在左側功能表的 [監視] 下，選取 [分析 (傳統)]。
  3. 選取資料的時間範圍，或輸入自訂時間範圍。
  4. 選取分析資料的報表類別，例如 [時間表]、[地理位置] 等等。
  5. 可選擇依一或多個其他類別來篩選報表。

使用 API 管理 REST API 中的報表作業，以擷取和篩選 API 管理執行個體的分析資料。

可用的作業會依 API、地理位置、API 作業、產品、要求、訂用帳戶、時間或使用者來傳回報表記錄。

Azure 監視器記錄

本節說明如何啟用 Azure 監視器記錄，以稽核和疑難解答 API 管理實例不同功能的使用方式。 藉由啟用診斷設定，您可以啟用下列一或多個資源記錄類別的集合：

類別 描述 註釋
API 管理閘道 API 管理閘道所處理的要求，包括 HTTP 方法、通訊協定、要求和響應主體、標頭、計時、錯誤詳細數據和快取參與。 調整所有 API 的設定，或針對個別 API 進行覆寫。

在以 工作區設定的 API 管理實例中，您可以針對每個工作區個別收集網關記錄，並匯總平臺小組的集中式存取。
WebSocket 連線 WebSocket API 連線的事件，從交握開始，直到聯機終止為止。
開發人員入口網站使用方式 API 管理 開發人員入口網站接收和處理的要求，包括使用者驗證動作、API 詳細數據檢視，以及互動式測試控制台中的 API 測試。
生成式AI入口 API 管理閘道處理大型語言模型（LLM）REST API 如 Microsoft Foundry API 的請求，包括令牌使用、模型，以及可選的請求提示與回應完成細節。 啟用特定 LLM API 的要求訊息和/或回應訊息的記錄功能。

如需詳細資訊，請參閱 API 管理監視數據參考。

啟用 Azure 監視器記錄的診斷設定

若要設定資源記錄集合的診斷設定：

  1. 在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。

  2. 在左側功能表的 [監視] 底下，選取 [診斷設定]>[+ 新增診斷設定]。

    在入口網站中新增診斷設定的螢幕擷取畫面。

  3. 在 [診斷設定] 頁面上，為設定輸入或選取詳細資料：

    1. 診斷設定名稱：輸入描述性名稱。
    2. 類別群組：(選用) 為您的案例選取此項目。
    3. 在 [類別]底下：選取一或多個類別。 例如，選取 [與 ApiManagement 網關相關的記錄 ] 來收集對 API 管理閘道大部分要求的記錄。
    4. 在 [目的地詳細資料] 底下，選取一或多個選項，並指定目的地的詳細資料。 例如，將記錄傳送至 Azure Log Analytics 工作區、將記錄封存至記憶體帳戶，或將它們串流至事件中樞。 如需詳細資訊，請參閱 Azure 監視器中的診斷設定：資源記錄。
    5. 選取 [儲存]。

    小提示

    • 若要在 [以 Azure 監視器為基礎的儀表板] 的 APIM ([監視]> [分析] 窗格) 中檢視 API 分析，請選取 Azure Log Analytics 工作區作為目的地。
    • 如果您選取 Log Analytics 工作區，您可以選擇將資料儲存在資源特定數據表中（例如 ApiManagementGatewayLogs 數據表），或儲存在一般 AzureDiagnostics 數據表中。 我們建議針對支援其記錄目的地使用資源特定資料表。 瞭解更多資訊

  4. 為一個多個記錄目的地設定詳細資料之後，選取 [儲存]。

附註

如果 APIM 服務的 MinApiVersion 屬性設定為高於 2022-09-01-preview 的任何 API 版本，新增診斷設定物件可能就會導致失敗。

附註

若要啟用 API 管理工作區的診斷設定，請參閱 建立和管理工作區。

檢視 Azure 監視器記錄數據

視您選擇的記錄目的地而定，可能需要幾分鐘的時間才會顯示資料。

在Log Analytics工作區中檢視記錄

如果您在 Log Analytics 工作區中啟用記錄或計量的集合，資料可能需要幾分鐘的時間才會出現在 Azure 監視器和以 Azure 監視器為基礎的 APIM 儀表板中 ([監視]> [分析] 窗格)。

若要檢視資料：

  1. 在 Azure 入口網站中，瀏覽至您的 API 管理執行個體。

  2. 在左側功能表中的 [ 監視] 底下，選取 [ 記錄]。

  3. 執行查詢以檢視資料。 您可以使用數個隨附的範例查詢，或執行您自己的查詢。 例如，下列查詢會從 ApiManagementGatewayLogs 資料表中擷取最近 24 小時的資料：

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    在入口網站中查詢 ApiManagementGatewayLogs 資料表的螢幕擷取畫面。

檢視記憶體帳戶中的記錄

如果您將記錄傳送至儲存體帳戶，則可以在 Azure 入口網站中存取資料，並加以下載以供分析。

  1. 在 Azure 入口網站中，瀏覽至儲存體帳戶目的地。
  2. 在左側功能表上，選取 [儲存體瀏覽器]。
  3. 在 Blob 容器 下，為日誌數據選擇一個名稱，例如 insights-logs-developerportalauditlogs，以用於開發人員入口網站的使用記錄。
  4. 瀏覽至容器以取得 APIM 執行個體中的記錄。 記錄會以 1 小時的間隔進行分割。
  5. 若要擷取資料以進行進一步分析，請選取 [下載]。

修改 API 記錄設定

當您使用入口網站建立診斷設定以啟用 APIM 閘道或生成式 AI 閘道 (大型語言模型) 記錄的集合時，記錄會以預設設定啟用。 默認設定不包含要求或回應的詳細數據，例如要求或響應主體。 您可以調整所有 API 的記錄設定，或覆寫個別 API 的記錄設定。 例如，調整閘道日誌數據的取樣率或詳細程度，啟用 LLM 請求或響應消息的記錄，或停用某些 API 的記錄。

如需記錄設定的詳細資訊，請參閱 診斷 - 建立或更新 和 API 診斷 - 建立或更新 REST API 參考頁面。

設定所有 API 的記錄設定：

  1. 在 APIM 執行個體的左側功能表中，選取 [API]> [API]> [所有 API]。
  2. 從頂端列中，選取 [設定] 索引標籤。
  3. 向下捲動至 [診斷記錄] 區段，然後選取 [Azure 監視器] 索引標籤。
  4. 檢閱設定，並視需要進行變更。 選取 [儲存]。

設定特定 API 的記錄設定：

  1. 在 APIM 執行個體的左側功能表中，選取 [API]> [API]，然後選取 API 的名稱。
  2. 從頂端列中，選取 [設定] 索引標籤。
  3. 向下捲動至 [診斷記錄] 區段，然後選取 [Azure 監視器] 索引標籤。
  4. 檢閱設定，並視需要進行變更。 選取 [儲存]。

重要事項

API 管理會將傳送至 Azure 監視器的記錄項目的大小強制限制為 32 KB。 記錄項目超過限制時的行為取決於記錄類別和記錄的數據屬性：

  • APIM 閘道記錄 - 若已收集，記錄於記錄項目中的要求或回應承載，每項最多可達 8,192 位元組。 如果項目中的所有屬性組合大小超過 32 KB，APIM 會移除所有內文和追蹤內容來修剪項目。
  • 生成 AI 閘道日誌 - LLM 要求或回應訊息的大小上限為 32 KB，若有收集，則會以單一條目傳送。 大於 32 KB 的訊息會分割並記錄在 32 KB 區塊中，其中包含序號以供稍後重建。 要求訊息和回應訊息不能超過每個 2 MB。

使用 Azure 監視器工具來分析資料

這些 Azure 監視器工具可在 Azure 入口網站中取得，以協助您分析監視資料：

  • 有些 Azure 服務在 Azure 入口網站中具有內建的監視儀表板。 這些儀表板稱為「深入解析」，您可以在 Azure 入口網站中 Azure 監視器的 [深入解析] 區段內找到這些儀表板。

  • 計量總管可讓您檢視和分析 Azure 資源的計量。 如需詳細資訊，請參閱使用 Azure 監視器計量瀏覽器分析計量。

  • Log Analytics 可讓您使用 Kusto 查詢語言 (KQL) 來查詢和分析記錄資料。 如需詳細資訊，請參閱開始使用 Azure 監視器中的記錄查詢。

  • Azure 入口網站具有用於檢視和基本搜尋活動記錄的使用者介面。 若要進行更深入的分析，請將資料路由傳送至 Azure 監視器記錄，並在 Log Analytics 中執行更複雜的查詢。

  • Application Insights 會監視 Web 應用程式的可用性、效能和使用方式，因此您可以識別和診斷錯誤，無需要等待使用者回報錯誤。
    Application Insights 包含各種開發工具的連接點，並與 Visual Studio 整合以支援您的 DevOps 程序。 如需詳細資訊，請參閱 App Service 的應用程式監視 (部分機器翻譯)。

支援更複雜視覺效果的工具包括：

  • 儀表板 (機器翻譯) 可讓您將不同類型的資料合併到 Azure 入口網站中的單一窗格。
  • 活頁簿，這是能在 Azure 入口網站中建立的可自訂報表。 活頁簿可以包含文字、計量及記錄查詢。
  • Grafana 是在操作儀表板中表現相當出色的開放平台工具。 您可以使用 Grafana 來建立儀表板，納入 Azure 監視器以外多個來源的資料。
  • Power BI (機器翻譯) 是一項商務分析服務，可提供跨各種資料來源的互動式視覺效果。 您可以將 Power BI 設定為從 Azure 監視器自動匯入記錄資料，以利用這些視覺效果。

使用受控 Grafana 儀表板將 APIM 監視資料視覺化

您可以使用 Azure 受控 Grafana，將收集到 Log Analytics 工作區中的 APIM 監視資料視覺化。 使用預先建置的 APIM 儀表板，即時將從 APIM 執行個體收集到的記錄和計量視覺化。

在您的 APIM 執行個體：

  • 若要將 APIM 的資源記錄和計量視覺化，請設定診斷設定收集資源記錄，然後將其傳送至 Log Analytics 工作區。

  • 若要將 APIM 閘道的要求詳細資料視覺化，請將 APIM 執行個體與 Application Insights 整合。

    附註

    若要在單一儀表板中將資料視覺化，請設定 Log Analytics 工作區用於診斷設定，並設定相同資源群組中的 Application Insights 執行個體做為您的 APIM 執行個體。

在您的受控 Grafana 工作區上：

  • 若要建立受控 Grafana 執行個體和工作區，請參閱入口網站或 Azure CLI 的快速入門。
  • 受控 Grafana 執行個體必須位於與 APIM 執行個體相同的訂用帳戶中。
  • 建立時，即會自動為 Grafana 工作區指派 Microsoft Entra 受控識別，其獲指派訂用帳戶上的監視讀者角色。 此方法可讓您立即從新的 Grafana 工作區存取 Azure 監視器，而不需要手動設定權限。 深入了解如何針對受控 Grafana 設定資料來源。

首先，將 APIM 儀表板匯入至您的受控 Grafana 工作區。

若要匯入儀表板：

  1. 移至 Azure 受控 Grafana 工作區。 在入口網站中受控 Grafana 執行個體的 [概觀] 頁面上，選取 [端點] 連結。
  2. 在受控 Grafana 工作區中，移至 [儀表板]>[瀏覽]>[匯入]。
  3. 在 [匯入] 頁面的 [透過 grafana.com 匯入] 底下，輸入 16604，然後選取 [載入]。
  4. 選取 [Azure 監視器資料來源]，檢閱或更新其他選項，然後選取 [匯入]。

若要使用 APIM 儀表板：

  1. 在受控 Grafana 工作區中，移至 [儀表板]>[瀏覽]，然後選取您的 APIM 儀表板。
  2. 在頂端的下拉式清單中，選取您的 APIM 執行個體。 如果已設定，請選取 Application Insights 執行個體和 Log Analytics 工作區。

檢閱儀表板上的預設視覺效果，其看起來會類似以下螢幕擷取畫面：

受控 Grafana 工作區中的 APIM 儀表板螢幕擷取畫面。

匯出 Azure 監視器資料

您可以使用下列項目來將資料從 Azure 監視器匯出到其他工具：

若要開始使用 Azure 監視器 REST API，請參閱 Azure 監視 REST API 逐步解說 (機器翻譯)。

使用 Kusto 查詢來分析記錄資料

您可以使用 Kusto 查詢語言 (KQL) 來分析 Azure 監視器記錄資料。 如需詳細資訊，請參閱 Azure 監視器中的記錄警示。

使用 Azure 監視器警示將問題通知您

Azure 監視器警示可讓您識別和解決系統中的問題，並在您的客戶注意到它們之前，在您的監視資料中發現特定情況時主動通知您。 您可以在 Azure 監視器資料平台中設置任何計量或記錄資料來源的警示。 根據您監視的服務和收集到的監視資料，有不同類型的 Azure 監視器警示。 請參閱選擇正確的警示規則類型。

若要了解如何在 Azure APIM 中設定警示規則，請參閱設定警示規則 (部分內容可能是機器或 AI 翻譯)。

如需 Azure 資源的常見警示範例，請參閱記錄警示查詢範例 (機器翻譯)。

大規模實作警示

對於某些服務，若要進行大規模監控，您可以將相同計量警示規則套用至相同 Azure 區域中存在的多個同類型資源。 Azure 監視器基準警示 (AMBA) 提供半自動化方法以大規模實作重要的平台計量警示、儀表板和指導方針。

使用 Azure Advisor 來取得個人化的建議

對於一些服務，如果在資源作業期間發生重大狀況或有即將到來的變更，入口網站的服務 [概觀] 頁面上會顯示警示。 您可以在左側功能表中 [監視] 底下的 [Advisor 建議] 中找到警示的詳細資訊和建議的修正。 在正常作業期間，不會顯示 Advisor 建議。

如需 Azure Advisor 的詳細資訊，請參閱 Azure Advisor 概觀 (機器翻譯)。

相關內容

  • Last updated on