查看APIG的API调用日志

前提条件

已调用API。

查看API的调用日志

1. 进入API网关控制台页面。
2. 根据实际业务在左侧导航栏上方选择实例。
3. 在左侧导航栏选择“监控分析 > 日志分析”。
4. 开启日志分析。
   1. 在“日志分析”页签单击“配置访问日志”。

      如果当前实例所在地区为广州地区，请单击“日志与追踪配置”。

   2. 在弹窗中配置日志信息，完成后单击“确定”。

   表1 配置日志信息

   参数	说明
   启动日志记录	是否启用日志记录，默认关闭，仅启用后才能查看API的调用日志。
   日志组	选择日志流所在的日志组。 如果没有可选的日志组，单击“查看日志组”，跳转到云日志服务管理控制台，并创建一个日志组，具体操作请参考创建日志组。
   日志流	选择API调用日志要存储的日志流。 如果没有可选的日志流，单击“查看日志流”，跳转到云日志服务管理控制台，并创建一个日志流，具体操作请参考创建日志流。
   APM应用列表	选择APM应用，支持选择多个应用。选择应用后，可在APM侧查看完整的调用链以及业务拓扑。当前仅广州区域支持APM应用列表功能。 如果没有可选的APM应用，请单击“创建APM应用”创建，具体操作请参考创建应用。 APM支持链路追踪具体操作可参考APIG通过Opentelemetry方式接入APM。

5. 日志分析开启后，可以在界面上实时查看所有开放API的调用日志，日志字段说明请参见表2。
6. 如需导出日志，具体步骤请参见日志转储。

   访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下表：

   表2 日志字段说明

   序号	字段	说明
   1	remote_addr	客户端地址。
   2	request_id	请求ID。
   3	api_id	API ID。
   4	user_id	当使用IAM认证访问时，请求方提供的项目ID。
   5	app_id	当使用APP认证访问时，请求方提供的APP ID。
   6	time_local	请求完成时间。
   7	request_time	请求延迟（单位：秒）。
   8	request_method	HTTP请求方法。
   9	scheme	请求协议。
   10	host	请求域名。
   11	router_uri	请求URI。
   12	server_protocol	请求协议。
   13	status	响应状态码。
   14	bytes_sent	响应大小（单位：字节，包含状态行、响应头、响应体）。
   15	request_length	请求长度（单位：字节，包含起始行、请求头、请求体）。
   16	http_user_agent	用户代理标识。
   17	http_x_forwarded_for	X-Forwarded-For头。
   18	upstream_addr	请求的后端地址。
   19	upstream_uri	请求后端的URI。
   20	upstream_status	后端响应状态码。
   21	upstream_connect_time	与后端建立连接所用时间（单位：秒）。
   22	upstream_header_time	从开始与后端建立连接到从后端获取到首字节所用时间（单位：秒）。
   23	upstream_response_time	从开始与后端建立连接到从后端获取到最后一个字节所用时间（单位：秒）。
   24	region_id	云服务区ID。
   25	all_upstream_response_time	从开始与后端建立连接到从后端获取到最后一个字节所用时间（单位：秒）。发生重试时，为所用时间总和。
   26	errorType	API请求的错误类型。 0：非流控错误 1：流控错误
   27	auth_type	API认证类型。
   28	access_model1	认证模式1。
   29	access_model2	认证模式2，开启双重认证时，为自定义认证编号。
   30	inner_time	apig的内部处理时长，单位秒。
   31	proxy_protocol_vni	VPC终端节点的虚拟网络标识。
   32	proxy_protocol_vpce_id	VPC终端节点的ID。
   33	proxy_protocol_addr	客户端源IP地址。
   34	body_bytes_sent	API请求的Body体大小，单位字节。
   35	api_name	API名称。
   36	app_name	当使用APP认证访问时，请求方使用的APP名称。
   37	provider_app_id	API所属的APP ID。
   38	provider_app_name	API所属的APP名称。
   39	custom_data_log1	用户自定义日志字段值1。
   40	custom_data_log2	用户自定义日志字段值2。
   41	custom_data_log3	用户自定义日志字段值3。
   42	custom_data_log4	用户自定义日志字段值4。
   43	custom_data_log5	用户自定义日志字段值5。
   44	custom_data_log6	用户自定义日志字段值6。
   45	custom_data_log7	用户自定义日志字段值7。
   46	custom_data_log8	用户自定义日志字段值8。
   47	custom_data_log9	用户自定义日志字段值9。
   48	custom_data_log10	用户自定义日志字段值10。
   49	response_source	请求响应来源。 local：APIG remote：后端服务
   50	gzip_ratio	原始响应body体大小与压缩后大小的比率。
   51	upstream_scheme	后端协议类型。
   52	group_id	分组ID。
   53	apig_err_code	网关错误码。
   54	function_urn	函数URN。
   55	cache_status	记录请求是否命中缓存： MISS，表示目前没有响应缓存，通常在第一次请求API时出现。 BYPASS，表示请求被绕过了缓存，直接转发到上游服务器。 STALE，表示缓存中的响应已经过期，需要从上游服务器获取新的响应。 HIT，表示响应是从缓存中提供的，而不是从上游服务器实时获取的。
   56	authorizer_downgrade	自定义认证开启宽松模式后，降级标识位： 1，表示只有前端自定义认证降级。 2，表示只有后端自定义认证降级。 3，表示前端和后端自定义认证都降级。 -，表示未降级。
   57	x_apm_version	链路追踪的版本。
   58	x_apm_trace_id	唯一标识一次请求的全局追踪ID。
   59	x_apm_parent_span_id	标识当前请求的父级Span ID。
   60	x_apm_trace_flags	是否启用采样：01，启用；02，不启用。
   61	x_apm_span_id	标识当前请求的Span ID。