監控您的 API

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

事前準備

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

API 總覽

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

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

    前往 Endpoints 服務頁面

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

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

圖表

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

  • 使用第一個圖表右上角的「Select graphs」(選取圖表) 下拉式選單來顯示您感興趣的指標圖表,並移除您不想要的圖表。下拉式選單中的每個項目都有一個問號,您可以將游標懸停在上方,查看顯示的指標說明。

  • 在總覽的右上角,選取不同的時間範圍來調整圖表。這項操作可調整圖表中顯示值的時間範圍,並改變資料點的精細程度。

方法資料表

當您準備好進一步細查時,請向下捲動到圖表下方的一個資料表,其中包含您 API 中各個方法的指標,您可以:

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

  • 使用總覽右上角的時間範圍挑選器,為資料表中的指標值選取時間範圍。這項操作可同時為圖表和資料表挑選時間範圍。

記錄

如果發現指標有問題,請前往Google Cloud 控制台的「Logs Explorer」頁面,查看 API 的要求與回應記錄。

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

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

  • 如要直接從「Logs Explorer」頁面找出 Endpoints 記錄:

    1. 在 Google Cloud 控制台中,前往「Stackdriver」 >「Logging」頁面:

      前往「Logs Explorer」(記錄檔探索工具) 頁面

    2. 選取 [Produced API] (產生的 API)、SERVICE_NAME,其中 SERVICE_NAME 是 Endpoints 服務的名稱。

如要進一步瞭解 Logs Explorer 中的記錄結構,請參閱 Endpoints 記錄參考資料。

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

  • 開始使用Logs Explorer。

    建立查詢,指定要查看的記錄項目集,例如取得延遲時間大於 300 毫秒的所有要求。

  • 設定及管理接收器,將記錄檔傳送至支援的目的地。這項操作可讓您將記錄檔串流至 BigQuery,以便進一步分析、將原始記錄檔儲存至 Cloud Storage,或是傳送至 Pub/Sub 訊息傳遞主題。

篩選特定的消費者專案