Endpoints 記錄

當使用者向您的 API 提出要求時,可擴充服務 Proxy (ESP) 會使用 Stackdriver Logging 記錄這些要求和回應的相關資訊。本頁將說明 Google Cloud Endpoints 記錄的資訊。

如要在「Logs Viewer」(記錄檢視器) 頁面中尋找 Cloud Endpoints 記錄:

  1. 在 Google Cloud Platform 主控台中,前往「Stackdriver」>「Logging」(記錄) 頁面:

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

  2. 選取「Produced API」SERVICE_NAME,其中 SERVICE_NAME 是 Endpoints 服務的名稱。

  3. 按一下您要審查的記錄,該記錄會包含結構化 JSON 訊息,如下方範例:

    {
      insertId: "…"
      jsonPayload: {…}
      resource: {
        type: "api"
        labels: {…}
      }
      timestamp: "2017-05-08T15:00:02.804424422Z"
      severity: "INFO"
      logName: "…"
    }
    

jsonPayload 物件包含由 ESP 報告的所有資訊。下表說明其欄位:

欄位 說明
url 要求的網址路徑。
producer_project_id 擁有 API 的 Google Cloud Platform (GCP) 專案 ID。
api_name 呼叫的 API 名稱。
api_version 呼叫的已命名 API 版本。
api_method 呼叫的已命名 API 方法。
api_key 呼叫的消費者所使用的 API 金鑰 (如果有)。
http_method 要求的 HTTP 方法,例如 GETPOST
request_size_in_bytes 要求主體的大小 (以位元組為單位)。
http_response_code 回應的 HTTP 狀態碼,例如 200404500
response_size_in_bytes 回應主體的大小 (以位元組為單位)。
request_latency_in_ms 回應要求所耗費的時間 (以毫秒為單位),包括 ESP 及其後端所耗費的時間。串流方法沒有這個欄位。
timestamp 要求傳入時的時間戳記。
location 為要求提供服務的 GCP 區域。
log_message 呼叫的方法遭拒時,有關該方法和其狀態的簡短訊息。遭拒的呼叫不會留下 API 資訊欄位記錄。
error_cause 傳回錯誤回應時的錯誤訊息。
labels labels 區段包含的資訊可識別記錄來源,例如 GCP 專案 ID、Endpoints 服務名稱、API 版本號碼與方法名稱。

後續步驟

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

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

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