建立及管理自訂報表

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

自訂報表可讓您深入瞭解特定 API 指標,並查看所需的確切資料。您可以使用 Apigee 內建的任何指標維度建立自訂報表。

自訂報表分為兩種類型:

  • 即時報表 (也稱為同步報表):在 Apigee UI 中指定報表參數後,即時報表會在幾分鐘內顯示在 Apigee UI 中。
  • 報表工作 (也稱為非同步報表):對於自訂報表工作,您會要求報表,並在稍後擷取結果。

請參閱「即時報表與報表工作」。

自訂報表的可用性

如果您是 Apigee Subscription 客戶,則 Apigee API Analytics 和自訂報表功能已納入訂閱授權,並會自動為每個 Apigee 環境啟用。

如果您是Pay-as-you-go客戶,則必須將 Apigee API Analytics 設為付費外掛程式,才能存取數據分析並產生自訂報表。如要進一步瞭解如何為 Apigee 中級或進階環境啟用 Apigee API Analytics 外掛程式,請參閱「 管理 Apigee API Analytics 外掛程式」。

如果不確定自己是否使用訂閱或即付即用的 Apigee 機構,請與 Apigee 機構管理員聯絡。

關於自訂報表

建立自訂報表時,您可以選取要查看的資料 (指標)、以有意義的方式分組資料 (維度),並視需要根據資料的特定特徵 (篩選器) 限制傳回的資料。

您也可以將自訂報表中顯示的圖表類型設為長條圖或折線圖。下圖顯示每秒交易量指標的圖表範例,並依 API 代理程式維度分組:

  • 資料欄:每個 API 代理程式會以不同的資料欄表示:

    自訂欄圖表

  • 線條:每個 API 都由不同的線條表示:

    自訂折線圖

設定指標和維度

您為自訂報表選擇的指標,會指定您要評估的資料。常見的指標包括:
  • 每秒交易次數
  • 回應時間
  • 政策錯誤

除了標準指標和維度之外,您還可以針對使用「DataCapture」政策收集到的自訂資料建立自訂報表。請參閱「使用 DataCapture 政策收集自訂資料」。

部分指標可讓您設定匯總函式,以便針對該指標執行。舉例來說,您可以使用下列匯總函式搭配回應時間指標:

  • avg:傳回平均回覆時間。
  • min:傳回最短回應時間。
  • max:傳回最大回應時間。
  • sum:傳回所有回應時間的總和。

並非所有指標都支援所有匯總函式。指標說明文件包含一張表格,其中會指定指標名稱和指標支援的函式 (sumavgminmax)。

「維度」會指定指標資料的分組方式。舉例來說,您想建立顯示回應時間指標的自訂報表。您可以使用維度,依 API 產品、API Proxy 或開發人員電子郵件 (也可以是 AppGroup ID) 將指標資料分組,以便取得下列資訊:

  • 每個 API 產品的回應時間
  • 每個 API Proxy 的回應時間
  • 每封開發人員電子郵件的回覆時間

維度在自訂報表的圖表中顯示的方式取決於圖表類型:

  • 資料欄:每個資料欄對應不同的維度值。
  • 折線:圖表中的每條折線都對應不同的維度值,而 X 軸代表時間。

設定篩選器

篩選器可讓您限制自訂報表中顯示的指標資料,方法是針對要傳回的指標資料設定特定特徵。舉例來說,您可以建立篩選器,只查看回應時間大於特定值的資料,或是只查看特定名稱的 API Proxy 資料。

您可以使用條件式語法和運算子 (例如 eqnegtlt 等) 建立複雜的篩選器。

自訂報表範例

在最簡單的自訂報表類型中,您可以指定單一指標和單一維度。舉例來說,您可以使用下列設定定義自訂報表:

  • type = 資料欄
  • 指標 = 每秒平均交易次數
  • 維度 = API Proxy

自訂報表包含資料欄圖,其中「每秒平均交易次數」指標資料會依 API 代理程式維度分組:

自訂報表 tps

您可以在自訂報表中新增多個指標。舉例來說,您可以使用兩個指標定義自訂報表:

  • type = 資料欄
  • 指標 = 每秒平均交易次數
  • 指標 = 政策錯誤
  • 維度 = API Proxy

自訂報表會為每項指標提供個別圖表:

自訂報表包含兩個指標

您可以在自訂報表中加入多個維度。舉例來說,您可以使用下列包含兩個指標和兩個維度的設定,定義自訂報表:

  • type = 資料欄
  • 指標 = 每秒平均交易次數
  • 指標 = 政策錯誤
  • 維度 = API Proxy
  • 維度 = 要求動詞

即時報表與報表工作

Apigee Analytics 可讓您執行即時報表報表工作

  • 若是即時報表,您只要提出要求,報表就會在數據分析伺服器提供回應後立即顯示。不過,由於報表可能需要處理大量資料 (例如 100 GB),因此即時報表可能會因逾時而失敗。

    即時報表的時間範圍上限為 92 天。如果選取的時間範圍超過這個值,報表就會以報表工作執行。

    請參閱「執行自訂報表」。

  • 針對報表工作,您可以要求報表,並稍後擷取結果。以下是報表工作可能適合用於處理的情況:

    • 分析並建立跨越長時間間隔的報表。
    • 使用各種分組維度和其他限制來分析資料,這會使查詢變得複雜。
    • 發現部分使用者或機構的資料量大幅增加時,管理查詢。

    您也可以使用 API 執行報表工作,如「使用非同步自訂報表 API」一文所述。請參閱「查看報表工作」。

開啟「自訂報表」頁面

如要開啟「自訂報表」頁面,請按照下列步驟操作:

  1. 開啟 Cloud 控制台中的 Apigee UI
  2. 依序選取「分析」>「自訂報表」。

系統隨即顯示「自訂報表」頁面:

自訂報表資訊主頁

「自訂報表」頁面有兩個分頁:

  • 報表:顯示即時報表。
  • 報表工作:顯示報表工作。

請參閱「即時報表與報表工作」。

這兩個分頁都會顯示已建立的報表或報表工作清單。 如要查看報表或報表工作,請按一下報表名稱。如需範例,請參閱「執行報表」。

報告

「報表」分頁會顯示每份報表的下列資訊:

  • 顯示名稱:報表名稱。
  • 維度:報表中包含的維度。
  • 指標:報表中包含的指標和匯總函式 (例如 sum)。
  • 上次修改時間:報表上次執行的時間和日期。

回報工作

「報表工作」分頁會顯示每個報表工作相關資訊,包括:

  • 報表名稱:報表名稱。
  • 開始時間範圍 (世界標準時間):報表工作的開始時間。
  • End Time Range (UTC):報表工作的結束時間。
  • 狀態:檢舉工作狀態,可能為「執行中」、「已完成」或「已過期」
  • 提交:提交報表工作時的日期和時間。

您可以在「自訂報表」頁面中:

建立自訂報表

本節將說明如何建立自訂報表。

您可以在「自訂報表」頁面中建立即時報表或報表工作。 方法如下:

  1. 開啟「自訂報表」頁面
  2. 按一下「+ 建立」
    • 如要建立即時報表,請選取「自訂報表」
    • 如要建立報表工作,請選取「自訂報表工作」
  3. 在「基本」部分中,輸入以下資訊:
    • 報表名稱:報表名稱。
    • 如要建立即時報表,您也可以視需要輸入報表的說明
  4. 以下各節取決於您是否要建立報表工作即時報表:
    • 僅限即時報表:

      在「圖表類型」後方,選取要用來呈現資料的圖表樣式:

      • 資料欄:X 軸代表由維度指定的群組。
      • 線條:X 軸代表時間。

    • 僅限報表工作:
      • 報表詳細資料:在「環境」欄位中,選取要執行報表的環境。請注意,對於即時報表,您可以在報表執行後,在報表頁面中選取環境。
      • 報表日期範圍:選取報表的「開始時間」和「結束時間」

        注意:報表工作的日期範圍最長為 365 天。如果報表需要精確到秒的日期範圍,請使用 Custom Reports API 建立報表工作。這個 API 接受包含秒數的日期範圍輸入內容。

  5. 在「指標」部分中:
    1. 選取要分析的指標
    2. 選取匯總函式,即可顯示「加總」、「平均」、「最小值」或「最大值」值。
    3. 按一下 [完成]

    注意:除了標準指標和維度之外,您還可以選取與使用 DataCapture 政策收集到的自訂資料相對應的指標或維度。

  6. 在「維度」欄位中,選取「Proxy」等維度,限制用於產生報表的資料集。您可以新增其他維度,進一步限制資料。
  7. 在「Filter」部分,您可以為報表定義新增篩選器,進一步縮小顯示的資料範圍。舉例來說,您可以新增篩選器,排除天氣 API 代理程式或開發人員 jane@example.com 的資料。

    首先,按一下「新增篩選器」,開啟「新增篩選器」部分。

    1. 選取要篩選的實體名稱,可以是指標或維度。
    2. 選取運算子 (例如 = 或 !=) 和值。
    3. 輸入指標或維度的值。
    4. 按一下「完成」即可新增篩選器。
  8. 按一下「儲存」即可儲存報表。

執行報表

如要執行即時報表,請按照下列步驟操作:

  1. 開啟「自訂報表」頁面。
  2. 在「報表」分頁中,選取要執行的報表。

報表生成完畢後,系統會顯示以下畫面:

顯示自訂報表。

報表會顯示資料圖表和摘要表格。

在報表頁面中,您可以為報表選取下列選項:

  • 環境:執行報表的環境。
  • 報表涵蓋的時間範圍。
  • 維度:報表的維度。一次只能顯示一個維度。
  • :維度的特定值,或「全部」可顯示所有值。

您也可以在報表頁面頂端選擇下列選項:

  • 編輯:編輯報表詳細資料。
  • 匯出:以 CSV 檔案格式下載報表資料。
  • 提交工作:將報表提交為報表工作。點選「提交工作」後,系統會開啟對話方塊,提供「建立自訂報表」一文中所述的選項。輸入選項後,按一下「建立」即可建立報表工作。

如要進一步瞭解報表工作,請參閱「查看報表工作」。

查看報表工作

如要查看報表工作,請選取「自訂報表」頁面頂端的「報表工作」分頁標籤。

系統會顯示「回報工作」分頁:

回報工作

您可以在「回報工作」頁面中執行以下操作:

  • 查看過去 7 天內提交的所有報表工作。

  • 選取要顯示報表工作的環境。

  • 在搜尋框中輸入相關字串的全部或部分內容,即可搜尋自訂報表清單;系統會在所有顯示的欄位中搜尋該字串。

如要查看自訂報表,請確認其「狀態」已完成。 然後按一下報表名稱即可查看報表。

編輯自訂報表

如要編輯自訂報表,請按照下列步驟操作:

  1. 開啟「自訂報表」頁面。
  2. 按一下「動作」下方的三點選單。
  3. 選取「編輯」。這會開啟「編輯自訂報表」對話方塊,您可以在其中編輯報表的選項。如要瞭解這些選項,請參閱建立自訂報表一文。
  4. 按一下 [Update] (更新),儲存您所做的變更。

刪除自訂報表

如要刪除自訂報表,請按照下列步驟操作:

  1. 開啟「自訂報表」頁面。
  2. 按一下「動作」下方的三點選單。
  3. 按一下「刪除」即可刪除報表。