監控您的 API
本頁面說明如何使用 API Gateway 自動維護的記錄和指標,監控 API Gateway API 的健康狀態。
建立 API 時,API Gateway 會自動建立相應的受管理服務。您可以在下列指令的輸出內容中,找到建立的代管服務名稱:
gcloud api-gateway apis describe API_ID
服務名稱是 managedService
欄位的值。
當使用者向您的 API 提出要求時,API Gateway 會記錄要求和回應的相關資訊。API Gateway 還會追蹤監控四大黃金訊號中的三種:延遲、流量,以及錯誤。這些使用狀況與效能指標有助於監控您的 API。
事前準備
如要產生記錄和指標以供查看,請部署 API 並向其傳送要求。如果您尚未建立 API 並部署至閘道,請試試 API Gateway 快速入門導覽課程。
API 總覽
如果您要對服務中的問題進行偵錯,或者只是想確保一切運作正常,請前往您的 API 總覽:
在 Google Cloud 控制台中,前往專案的「API Gateway」 >「API」頁面:
如果您有多個 API,請按一下您要監控的 API。
確保您位於「Overview」(總覽) 分頁上。
圖表
總覽頁面會提供一些指標的圖表,讓您立即發現任何激增、下降或意外活動。您可以使用頁面頂端的篩選器:
- 使用「Select graphs」下拉式選單,顯示您感興趣的指標圖表,並移除您不想要的圖表。
- 選取不同的時間範圍,調整圖表的範圍。這項操作可調整顯示值的時間範圍,並改變資料點的精細程度。
方法資料表
當您準備好進一步細查時,請向下捲動到圖表下方的一個資料表,其中包含您 API 中各個方法的指標,您可以:
- 按一下表格左上角的「篩選器表格」圖示,從下拉式表格中選取精細篩選器查詢選項。在每個篩選查詢中加入
OR
,即可同時搜尋多個字詞。 - 按一下表格右上角的「欄顯示選項」圖示,即可顯示下拉式清單。勾選您感興趣的指標,並清除不想顯示的指標。
- 在「總覽」頁面的右上角,使用時間範圍挑選器為資料表中的指標值選取時間範圍。這項操作可同時為圖表和資料表挑選時間範圍。
記錄
如果您發現指標有問題,可以使用Google Cloud 控制台的「Logs Explorer」頁面,查看 API 的要求與回應記錄。
如要查看個別 API 方法的記錄,請按一下資料表中的 [View logs] (查看記錄)。
如要直接從「Logs Explorer」(記錄檔探索工具) 頁面找出 API Gateway 記錄:
前往 Google Cloud 控制台的「Logs Explorer」頁面:
選取「Produced API,
SERVICE_NAME
」,其中SERVICE_NAME
是受管理服務的名稱。
如要進一步瞭解記錄檢視器中的記錄結構,請參閱 API Gateway 記錄參考資料。
瞭解您還可以利用記錄執行哪些作業:
開始使用記錄檔探索工具。
使用查詢窗格指定要查看的記錄項目集,例如取得延遲時間大於 300 毫秒的所有要求。
設定及管理接收器。這項操作可讓您將記錄檔串流至 BigQuery,以便進一步分析、將原始記錄檔儲存至 Cloud Storage,或是傳送至 Pub/Sub 訊息傳遞主題。
篩選特定的消費者專案
如何篩選特定消費者專案的指標:
取得 API 消費者專案的專案編號。如果您沒有該項 API 使用者專案的存取權限,請要求具備相關權限的人員為您取得專案編號。
在 Google Cloud 控制台中,前往專案的「API Gateway」 >「API」頁面。
在「Overview」(總覽) 頁面的左上角,於「Filter by Project Number」(依專案編號篩選) 欄位輸入專案編號。
按一下 [Filter] (篩選)。
頁面上的指標會更新為僅顯示來自指定專案的流量。