文档中心 API 网关 日志管理

日志管理

最近更新时间:2019-06-26 10:34:28

操作场景

您可以开启日志管理功能,将自身的调用日志存放在日志集中。

说明:

日志管理功能目前为灰度测试阶段,如需使用请联系您的客户经理或 提交工单 申请开启。

操作步骤

创建日志规则

  1. 登录 API 网关控制台,在左侧导航中选择【日志管理】。
  2. 在日志管理页面,单击左上角的【新建】,开始新建日志收集规则。
    第一次使用时,您需要对 API 网关采集日志服务进行授权,步骤如下:
    1. 在创建服务角色的对话框中,单击前往【访问管理】。
    2. 在访问管理的角色管理页面,单击【同意授权】,完成后自动跳转至 API 网关的日志管理页面。
  3. 在添加日志规则的对话框中,填写日志规则名称、采集数据和投递的目标日志集。
    • 名称:API 网关的日志管理能力使用了腾讯云平台的日志服务,在新建日志规则时,可对日志规则进行命名。
    • 采集数据:选择所需收集的通账户下的日志服务及服务中的具体环境。
    • 投递到日志集:通过选择日志集而确定将这些信息投递到日志服务的哪个日志集中。若您还没有创建日志集,则需要在日志服务页面先进行创建。
  4. 创建成功后,即可在日志管理页面查看并编辑日志规则。

查看日志

API 网关的日志收集到日志服务中后,您可在日志服务页面对应的日志集下进行查看。

您还可根据关键字进行日志检索。

其他具体日志服务的使用,请参考日志服务文档 开启索引

日志格式说明

API 网关日志格式如下:

log_format  
'[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]'
'[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]' 
'[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]'
'[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local]';
  • app_id: 用户 ID。
  • env_name:环境名称。
  • service_id: 服务 ID。
  • http_host: 域名。
  • api_id: API 的 ID。
  • uri:请求的路径。
  • scheme: HTTP/HTTPS 协议。
  • rsp_st: 请求响应状态码。
  • ups_st: 后端业务服务器的响应状态码(如果请求透传到后端,改变量不为空。如果请求在 APIGW 就被拦截了,那么该变量显示为 -)。
  • cip: 客户端 IP。
  • uip: 后端业务服务(upstream)的 IP。
  • vip: 请求访问的 VIP。
  • rsp_len: 响应长度。
  • req_len: 请求长度。
  • req_t: 请求响应的总时间。
  • ups_rsp_t: 后端响应的总时间(apigw 建立连接到接收到后端响应的时间)。
  • ups_conn_t: 与后端业务服务器连接建立成功时间。
  • ups_head_t:后端响应的头部到达时间。
  • err_msg: 错误信息。
  • tcp_rtt: 客户端 TCP 连接信息,RTT(Round Trip Time)由三部分组成:链路的传播时间(propagation delay)、末端系统的处理时间、路由器缓存中的排队和处理时间(queuing delay)。