監控您的 API

本頁說明如何使用 Google Cloud Endpoints 自動為您維護的記錄和指標,來對您所擁有的 API 進行健康狀態監控。當使用者向您的 API 提出要求時,Endpoints 會記錄要求和回應的相關資訊。Endpoints 還會追蹤監控四大黃金訊號中的三種:延遲、流量以及錯誤。這些使用狀況與效能的指標有助於監控您的 API。

事前準備

您必須部署您的 API 並向其傳送要求,才能產生記錄和指標以進行查看。如果您尚未開始設定,可以先參考 Endpoints 快速入門導覽課程

API 總覽

如果您要對服務中的問題進行偵錯,或者只是想確保一切運作正常,請前往您 API 的總覽:

  1. 在 Google Cloud Platform 主控台中,前往您專案的「Endpoints Services」(Endpoints 服務) 頁面:

    前往「Endpoints Services」(Endpoints 服務) 頁面

  2. 如果有多個 API,請按一下您要監控的 API。

  3. 確保您位於「總覽」分頁上。

圖表

最頂端是一些指標的圖表,因此您可以立即發現任何激增和下降的情形。您可以執行以下操作:

  • 在第一個圖表的右上角,使用 [Select graphs] (選取圖表) 下拉式選單,即可顯示出感興趣指標的圖表,也可以移除不想看的圖表。下拉式選單中的每個項目都有一個問號,將游標懸停在其上,就會看到該項目顯示的指標的說明。

  • 在總覽的右上角,可選取不同的時間範圍來調整圖表。如此可以調整這些圖表中顯示值的時間範圍,並且也會改變資料點的精細程度。

方法資料表

當您準備好進一步深入瞭解時,請向下捲動到圖表下方的一個資料表,其中包含您 API 中各個方法的指標。而您可以執行下列操作:

  • 在資料表的右上角,使用 [Select columns] (選取資料欄) 下拉式選單,即可顯示您感興趣的指標,並移除不想要顯示的指標。這裡的各個項目也都有一個問號,您可將游標懸停在其上以查看說明。

  • 在總覽的右上角,可使用時間範圍挑選器來選擇資料表中指標值的時間範圍。如此可同時為圖表和資料表挑選時間範圍。

記錄

當您在指標中發現問題時,請前往 Google Cloud Platform 主控台中的「Logs Viewer」(記錄檢視器) 頁面,即可查看 API 的要求與回應記錄。

  • 如要查看個別 API 方法的記錄,請按一下資料表中的 [View logs] (查看記錄)。

  • 如要查看所有 API 方法的記錄,請按一下右下角的 [View all logs] (查看所有記錄)。

  • 如何直接從「Logs Viewer」(記錄檢視器) 頁面尋找 Endpoints 記錄:

    1. 在 GCP 主控台中,前往 [Stackdriver] > [Logging] (記錄) 頁面:

      前往「Logs Viewer」(記錄檢視器) 頁面

    2. 選取要記錄的服務。

    3. 選取 endpoints_log

如要進一步瞭解記錄檢視器中的記錄結構,請參閱 Endpoints 記錄參考資料

瞭解您還可以利用記錄執行哪些作業:

篩選特定的消費者專案

如要查看特定消費者專案的指標,您的 API 消費者必須在提出要求時傳送 API 金鑰。因為 Endpoints 會使用 API 金鑰來識別與呼叫應用程式相關聯的專案,所以 API 消費者的 GCP 專案中必須已建立該 API 金鑰。如要瞭解如何使用 API 金鑰限制對 API 的存取,請參閱以下內容:

如何篩選特定消費者專案的指標:

  1. 取得 API 消費者專案的專案編號。如果您沒有該 API 消費者專案的存取權限,可以請有權限的人員為您取得專案編號。

  2. 在 GCP 主控台中,前往專案的「Endpoints Services」(Endpoints 服務) 頁面。

    前往「Endpoints Services」(Endpoints 服務) 頁面

  3. 在「Overview」(總覽) 頁面的左上角,在「Filter by Project Number」(依專案編號篩選) 欄位輸入專案編號。

  4. 按一下 [Filter] (篩選)

頁面上的指標會更新為僅顯示來自指定專案的流量。

快訊

Stackdriver 中也會提供 Endpoints 收集的指標。您可以使用 Stackdriver 來設定有關延遲、流量和錯誤的快訊。唯一無法使用 Endpoints 指標設定快訊的黃金訊號是飽和度。飽和度監控所需的指標視您的應用程式而定。請參閱 Stackdriver Monitoring 中提供的指標清單,以瞭解可用於設定飽和度快訊的指標。

如何設定快訊:

  1. 如果您還沒有 Stackdriver 帳戶,請為您的專案建立 Stackdriver 帳戶,並確定 Endpoints 監控的 API 的專案 ID 已與這個帳戶建立關聯。

  2. 建立快訊政策,即可使用以下項目設定黃金訊號的快訊:

    • 延遲時間

      1. 將「Condition Type」(條件類型) 設為 Metric Threshold
      2. 將「Resource Type」(資源類型) 設為 Produced API
      3. 對於指標,請輸入 Request latencies
      4. 輸入發出快訊的臨界值,然後按照快訊指南的其餘部分進行操作。
    • 流量

      1. 將「Condition Type」(條件類型) 設為 Metric Threshold
      2. 將「Resource Type」(資源類型) 設為 Produced API
      3. 對於指標,請輸入 Request count
      4. 輸入發出快訊的臨界值,然後按照快訊指南的其餘部分進行操作。
    • 錯誤

      1. 將「Condition Type」(條件類型) 設為 Metric Threshold
      2. 將「Resource Type」(資源類型) 設為 Produced API
      3. 對於指標,請輸入 Request count
      4. 對於 response-code-class,請輸入 5xx
      5. 輸入發出快訊的臨界值,然後按照快訊指南的其餘部分進行操作。

後續步驟

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁