共用方式為


監視 API 管理

適用於:所有 APIM 層

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

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

使用 Azure 監視器收集數據

下表描述如何收集數據來監視服務,以及一旦收集數據后,您可以執行哪些動作:

要收集的資料 描述 如何收集和路由數據 檢視數據的位置 支援的資料
計量資料 計量為數值,可描述系統在特定時間點的某個方面。 相較於其他計量,您可以使用演算法匯總計量,並分析一段時間的趨勢。 - 定期自動收集。
- 您可以將某些平台計量路由傳送至 Log Analytics 工作區,以與其他數據進行查詢。 檢查每個計量的 DS 匯出 設定,以查看您是否可以使用診斷設定來路由計量數據。
計量瀏覽器 Azure 監視器支援的 Azure API 管理 計量
資源記錄數據 記錄會記錄具有時間戳的系統事件。 記錄可以包含不同類型的數據,而且是結構化或自由格式的文字。 您可以將資源記錄數據路由傳送至 Log Analytics 工作區,以進行查詢和分析。 建立診斷設定 以收集和路由傳送資源記錄數據。 Log Analytics Azure API 管理 Azure 監視器所支援的資源記錄數據
活動記錄數據 Azure 監視器活動記錄提供訂用帳戶層級事件的深入解析。 此活動記錄包含像是何時修改資源或啟動虛擬機器的資訊。 - 自動收集。
- 免費建立Log Analytics工作區的診斷設定
活動記錄檔

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

內建監視 API 管理

Azure API 管理具有下列內建的監視功能。

取得 Azure API 管理中的 API 分析

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

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

注意

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

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

重要

以 Azure 監視器為基礎的儀表板是存取分析資料的建議方式。 v2 層未提供內建 (傳統) 分析。

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

  • Time
  • 地理位置
  • API
  • API 作業
  • 產品
  • 訂用帳戶
  • 使用者
  • 要求

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

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

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

如果您需要設定一個,以下是將閘道記錄傳送至 Log Analytics 工作區的簡短步驟。 如需詳細資訊,請參閱教學課程:監視已發佈的 API。 此程式是一次性設定。

  1. Azure 入口網站中,瀏覽至您的 API 管理執行個體。
  2. 在左側功能表的 [監視] 底下,選取 [診斷設定] > [+ 新增診斷設定]
  3. 輸入診斷設定的描述性名稱。
  4. 在 [記錄] 中,選取 [與 ApiManagement 閘道相關的記錄]
  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 APIM 中啟用開發人員入口網站的使用記錄

本節說明如何啟用 Azure 監視器記錄,以進行 API 管理 開發人員入口網站的稽核和疑難解答。 透過診斷設定加以啟用時,記錄會收集開發人員入口網站所接收和處理之要求的相關資訊。

開發人員入口網站使用記錄包含開發人員入口網站中活動的相關資料,包括:

  • 使用者驗證動作,例如登入和登出
  • API 詳細資料、API 作業詳細資料和產品的檢視
  • 互動式測試主控台中的 API 測試

啟用開發人員入口網站記錄的診斷設定

若要設定診斷設定以啟用開發人員入口網站使用記錄:

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

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

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

  3. 在 [ 診斷設定 ] 頁面上,輸入或選取設定的詳細數據:

    1. 診斷設定名稱:輸入描述性名稱。
    2. 類別群組:(選用) 為您的案例選取此項目。
    3. 在 [類別] 底下:選取 [與開發人員入口網站使用相關的記錄]。 (選用) 視需要選取其他類別。
    4. 在 [目的地詳細資料] 底下,選取一或多個選項,並指定目的地的詳細資料。 例如,將記錄封存至儲存體帳戶,或將記錄串流至事件中樞。 如需詳細資訊,請參閱 Azure 監視器中的診斷設定:資源記錄
    5. 選取儲存

檢視診斷記錄資料

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

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

  1. Azure 入口網站中,瀏覽至儲存體帳戶目的地。
  2. 在左側功能表上,選取 [儲存體瀏覽器]
  3. 在 [Blob 容器] 底下,選取 [insights-logs-developerportalauditlogs]
  4. 瀏覽至容器以取得 APIM 執行個體中的記錄。 記錄會以 1 小時的間隔進行分割。
  5. 若要擷取資料以進行進一步分析,請選取 [下載]

使用 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 執行個體收集到的記錄和計量視覺化。

在您的 API 管理 實例上:

  • 若要將 API 管理 的資源記錄和計量可視化,請設定診斷設定來收集資源記錄,並將其傳送至 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 監視器資料來源],檢閱或更新其他選項,然後選取 [匯入]

若要使用 API 管理 儀錶板:

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

檢閱儀錶板上的預設視覺效果,其看起來類似下列螢幕快照:

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

匯出 Azure 監視器數據

您可以使用:

若要開始使用 Azure 監視器 REST API,請參閱 Azure 監視 REST API 逐步解說

使用 Kusto 查詢來分析記錄數據

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

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

Azure 監視器警示 可讓您識別並解決系統中的問題,並在客戶注意到問題之前,在監視數據中找到特定條件時主動通知您。 您可以針對在 Azure 監視器資料平台中的任何計量或記錄資料來源發出警示。 根據您監視的服務,以及您要收集的監視數據,有 不同類型的 Azure 監視器警示 。 請參閱選擇正確的警示規則類型

若要瞭解如何在 Azure API 管理 中設定警示規則,請參閱設定警示規則

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

大規模實作警示

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

使用 Azure Advisor 取得個人化建議

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

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