Endpoints 日志

当用户向您的 API 发出请求时，Extensible Service Proxy (ESP) 会使用 Cloud Logging 记录请求和响应的相关信息。本页面介绍记录的信息。

如需在日志浏览器页面上查找 Cloud Endpoints 日志，请执行以下操作：

  1. 在 Google Cloud 控制台中，依次前往 Stackdriver > Logging 页面：

    转到“日志浏览器”页面

  2. 选择提供的 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 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 版本号，以及方法名称。

后续步骤