Endpoints 記錄

OpenAPI   |  gRPC

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

如要在「Logs Explorer」頁面中尋找 Cloud Endpoints 記錄：

1. 在 Google Cloud 控制台中，依序前往「Operations」 >「Logging」頁面：

   前往「Logs Explorer」頁面

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

   注意：只有在最近的記錄訊息含有 API 資源類型時，您才能從資源選單中選取「Produced API」。

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

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

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

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

後續步驟

• 監控 API

• 追蹤 API