建立及管理自訂報表

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

自訂報表可讓您深入探索特定 API 指標，以及查看您想要查看的確切資料。您可以使用 Edge 內建的任何metrics和維度建立自訂報表。 此外，您可以將 StatisticsCollector 政策附加至 API Proxy，藉此收集自訂指標，例如使用者或產品 ID、價格、REST 動作、目標版本、目標網址和訊息長度。

影片

請觀看下列影片，進一步瞭解自訂報表。

影片 說明
使用使用者介面建立自訂報表 瞭解如何使用 Edge UI 建立自訂報表。
自訂報表總覽 查看自訂報表的使用總覽。
追蹤 API 延遲時間 瞭解如何使用自訂報表追蹤 API 延遲時間。
追蹤 API 錯誤回應 使用自訂報表追蹤 API 錯誤回應。

關於自訂報表

建立自訂報表時，您可以選取想要查看的資料 (指標)，以有意義的方式 (維度) 將資料分組，還能選擇是否要根據資料的特定特性 (篩選器) 限制傳回的資料。

您也可以將自訂報表中顯示的圖表類型設為柱狀或折線圖。 下圖顯示依 API Proxy 維度分組的每秒交易次數指標範例：

  • 資料欄 - 每個 API Proxy 都以不同的資料欄表示：

    自訂柱狀圖

  • 行 - 每個 API 都以不同的一行表示：

    自訂折線圖

設定指標和維度

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

部分指標可讓您設定要對指標執行的匯總函式。舉例來說，您可以搭配使用下列匯總函式與回應時間指標：

  • avg：傳回平均回應時間。
  • min：傳回最短回應時間。
  • max：傳回回應時間上限。
  • sum：傳回所有回應時間的總和。

並非所有指標都支援所有匯總函式。metrics說明文件包含指定指標名稱的資料表，以及指標支援的函式 (sum、avg、min、max)。

「維度」會指定指標資料的分組方式。 舉例來說，假設您想建立自訂報表來顯示回應時間指標。您可以運用維度，依 API 產品、API Proxy 或開發人員電子郵件將指標資料分組，藉此取得：

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

報表在自訂報表圖表中顯示的方式，會因圖表類型而異：

  • 欄：每一欄分別對應維度的不同值。
  • 線條：圖表中的每一行分別對應維度的不同值，X 軸代表時間。

建立自訂指標和維度

將 StatisticsCollector 政策新增至 API Proxy，即可收集自訂數據分析資料，例如使用者或產品 ID、價格、REST 動作、目標版本、目標網址和訊息長度。資料可能來自 Apigee 預先定義的流程變數、要求標頭、查詢參數或您定義的自訂變數。資料收集完畢後，即可建立自訂報表來查看這些資料。

自訂數據分析資料在自訂報表中的顯示方式，視資料類型而定：

  • 針對類型字串的資料，在自訂報表中將統計資料做為維度參照。
  • 如為數值資料類型 (整數/浮點/長/雙精度浮點值)，請在自訂報表中以維度或指標參照統計資料。

如需收集自訂數據分析資料的範例，請參閱 StatisticsCollector 政策。

設定篩選器

「篩選器」可讓您針對要傳回的指標資料設定特定特性，藉此限制自訂報表中顯示的指標資料。例如，您可以建立篩選器，僅查看特定值大於或具有特定名稱的 API Proxy 的指標資料。

篩選器採用條件式語法，可讓您使用 eq、ne、gt、lt 等運算子建立複雜的篩選器。

自訂報表範例

在最簡單的自訂報表中，您指定了單一用途和一個維度。舉例來說，您可以使用下列設定定義自訂報表：

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

自訂報表包含一個柱狀圖，其中顯示「平均每秒交易次數」指標資料，以 API Proxy 維度分組：

自訂報表 TTP

顯示平均值的指標還會在圖表的右側顯示「顯示差異」連結，如上圖所示。將滑鼠遊標懸停在連結上，即可開啟資訊卡。 分散方塊會顯示資料的集中趨勢。

餐盒

您可以在自訂報表中加入多個指標。舉例來說，您定義了含有兩個指標的自訂報表：

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

自訂報表會針對每個指標分別提供圖表：

自訂報表的兩項指標

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

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

圖表一開始會顯示按 Proxy 分組的指標，也就是您建立自訂報表時指定的第一個維度：

自訂報表的兩個維度

然後，您可以使用與第一個維度對應的「Proxy」下拉式選單，選取個別 Proxy。更新後的圖表現在會依要求動詞顯示所選 Proxy 的指標：

自訂報表 (包含兩個維度)

隨著您在自訂報表中加入更多維度，使用者介面也會跟著調整，讓您按各個維度細查報表。

查看所有自訂報表

按照下方說明存取自訂報表頁面。

Edge

如何透過 Edge UI 存取自訂報表頁面：

  1. 登入 https://apigee.com/edge。
  2. 選取「分析」>「自訂報表」>「報表」。

傳統邊緣 (Private Cloud)

如何透過傳統版 Edge UI 存取自訂報表頁面：

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 選取「Analytics (分析)」>「報表」。

「自訂報表」頁面會顯示貴機構已建立的所有自訂報表，如下圖所示：

自訂報表資訊主頁

如圖中所示，自訂報表頁面可讓您進行以下操作：

  • 查看所有自訂報表的清單。
  • 新增自訂報表。
  • 在清單中按一下自訂報表名稱，即可執行自訂報表。根據預設，系統執行報表時會使用過去 1 小時內收集的資料，並在自訂報表資訊主頁中顯示資料。請參閱「探索自訂報表資訊主頁」一文。
  • 在搜尋框中輸入完整或部分相關字串，即可搜尋自訂報表清單；所有顯示的欄位都會搜尋字串。
  • 刪除自訂報表。

探索自訂報表資訊主頁

自訂報表資訊主頁會顯示特定時間範圍內的自訂報表結果，包括指定指標的欄或折線圖：

自訂報表資訊主頁

您可以透過自訂報表資訊主頁：

  • 查看所選時間範圍內的自訂報表資料。
  • 選取要查看自訂報表資料的環境。
  • 選取特定維度即可篩選自訂報表資料。只有在報表指定多個維度時，系統才會啟用這個區域。

  • 選取「圖表」或「表格」檢視。

  • 在相關指標的資料表列中選取 圖示，即可分析指標。查看異常狀況，並與前一期或其他指標進行比較。
  • 按一下並設定時間範圍，即可執行自訂報表。
  • 以 CSV 檔案格式下載自訂報表。檔案名稱如下所示：metric.csv。例如：Average_of_total_response_time.csv。
  • 編輯自訂報表。

探索指標分析資訊主頁

如果在摘要表格列中選取 圖示，系統會顯示下列圖表 (只有在您將報表設定為使用多個指標時，才會顯示頂端圖表)：

分析指標

這些圖表會顯示以下資訊：

  • 比較：如果設定報表使用多個指標，請相互比較指標。
  • 比較上一個時段：查看先前時間範圍的指標。 舉例來說，如果您選擇查看過去 24 小時的自訂報表，這張圖表會顯示過去 24 小時的資料。

  • 分析異常狀況：在報表資料中顯示所有異常資料點。這張圖表會顯示兩個值：

    • 指標的移動平均值，以線條形式顯示。在這個線條上的指定點，移動平均值的計算方法是在該時間點的指標值平均值，以及前兩個資料點的指標值。
    • 圖表的藍色區域定義了指標的平均最小值和平均值。平均最大值為 1.2 * (移動平均值)，平均最小值為 0.8 * (移動平均值)。

    如果移動平均值超出平均上限或平均最小值範圍，即視為可能有異常狀況，並以紅點繪製成圖表。

新增自訂報表

新增自訂報表後，您就能建立一組圖表，深入分析 API 計畫的各個面向。

新增自訂報表後，您必須以同步或非同步的方式run該報表。

新增自訂報表的步驟如下：

  1. 存取「自訂報表」頁面。
  2. 按一下「+ 自訂報表」。
  3. 在「基本」部分中輸入以下資訊：
    欄位 說明
    報表名稱 報表名稱。
    報表說明 報表說明。
    圖表類型 選取要用來呈現自訂數據分析資料的圖表樣式。
    • 欄：X 軸代表依維度指定的群組。
    • 線條：X 軸代表時間。
  4. 在「指標」部分：
    1. 按一下「指標」的 圖示。
    2. 選取要分析的指標。
    3. 選取「匯總函式」來顯示「總和」、「平均值」、「最小值」或「最大值」。
    4. 點按「儲存」。
    5. 按一下 圖示即可新增其他指標。
  5. 在「維度」部分中，按一下 ，然後選取維度 (例如「Proxy」)，藉此限制用來產生報表的資料集。您可新增其他維度，進一步限制資料。

  6. 前往「篩選器」部分，在報表定義中加入「篩選器」，進一步縮小顯示的資料範圍。舉例來說，您可以新增篩選器來排除氣象 API Proxy 或開發人員 jane@example.com 的資料。

    1. 按一下 做為要篩選的實體名稱、一個運算子 (例如 = 或 !=)，以及值。
    2. 按一下「新增」儲存篩選器。
    3. 按一下 新增其他篩選器，然後選取「且」或「或」連接器。

  7. 如要限制哪些人能存取自訂報表，請編輯針對報表定義的自訂角色。

    1. 按一下 ，即可編輯自訂角色設定。
    2. 選取存取報表所需的自訂角色和存取層級 (查看、編輯與刪除)。
    3. 按一下 [新增]。
    4. 按一下 即可編輯其他角色。
  8. 按一下「儲存」儲存報表。

執行自訂報表

Edge Analytics 可讓您以同步或非同步的方式執行報表。

  • 針對同步報表，您執行報表要求，且在分析伺服器提供回應之前，要求會遭到封鎖。不過，由於報表可能需要處理大量資料 (例如 100 GB)，因此同步作業可能會因逾時而失敗。

    同步報表的時間範圍最長可達 14 天。如果您選取的時間範圍 15 天以上，報表一律會非同步執行。

  • 非同步報表：執行報表要求，並稍後再擷取結果。在某些情況下，非同步查詢處理作業可能是不錯的替代方案，例如：

    • 分析及建立橫跨大量時間間隔的報表。
    • 運用各種分組維度和其他限制，讓查詢作業變得複雜
    • 當您發現某些使用者或機構的資料量大幅增加時，就可以管理查詢。

    本文將說明如何使用使用者介面啟動非同步報表。您也可以使用 API，如「使用非同步自訂報表 API」一文所述。

如要針對特定時間範圍執行自訂報表，請按照下列步驟操作：

  1. 存取「自訂報表」頁面。
  2. 選取要執行的報表。根據預設，報表會顯示前一小時的資料。

  3. 如何執行其他時間範圍的報表：

    1. 按一下報表頂端的時間範圍區域，開啟「自訂報表時間選項」彈出式視窗。
    2. 請選取下列其中一項：
      • 預先定義的時間範圍，例如「過去 1 小時」、「昨天」或「最近 7 天」。

      • 選取「From」/「To」日期和時間的「Custom Range」，或使用日曆選取開始和結束日期。按一下「UTC」即可使用世界標準時間 (UTC)。

    3. 如要執行報表，請選取下列其中一項：

      • 選擇「套用」，即可同步執行報表。報表完成後，結果會顯示在自訂報表資訊主頁中。如果報表執行時間超過 60 秒，系統會自動將報表轉換為非同步報表。

      • 提交工作，以非同步的方式執行報表做為背景工作。畫面上會顯示下列對話方塊：

        非同步提交

        按一下對話方塊中的「查看狀態」，查看自訂報表工作的狀態。

查看非同步自訂報表工作

如要查看非同步自訂報表工作，請選取下列其中一項：

  • 在「已提交為背景工作」對話方塊中，按一下「查看狀態」。
  • 在左側導覽列中，依序選取「分析」>「自訂報表」>「報表工作」。

畫面隨即顯示「報表工作」頁面，如下圖所示：

報表工作

透過「報表工作」頁面，您可以：

  • 查看過去 7 天內提交的所有非同步自訂報表工作結果。

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

  • 如要查看自訂報表，請確認「狀態」已完成。 接著，將滑鼠遊標移到報表對應的資料列上。 系統隨即會顯示 查看報表 和 下載報告 圖示。選取 查看報表 即可查看報表。

  • 按一下 下載報告 下載自訂報表。

    系統會將完整報表下載為名為 OfflineQueryResult-xxx.zip 的 ZIP 檔案，其中包含 CSV 檔案。

  • 在搜尋框中輸入完整或部分相關字串，即可搜尋自訂報表清單；所有顯示的欄位都會搜尋字串。

編輯自訂報表

如何編輯自訂報表：

  1. 存取「自訂報表」頁面。
  2. 將遊標移到要編輯的報表名稱上。 頁面右側會顯示編輯 和刪除 圖示。
  3. 按一下編輯圖示。
  4. 編輯自訂報表詳細資料。
  5. 點按「儲存」。

系統隨即返回自訂報表結果。

刪除自訂報表

刪除自訂報表的步驟如下：

  1. 存取「自訂報表」頁面。
  2. 將遊標移到要編輯的報表名稱上。 頁面右側會顯示編輯 和刪除 圖示。
  3. 按一下刪除圖示即可刪除報表。