文档中心

日志服务

请输入

APIG 日志采集

采集 APIG 日志

本文档介绍 APIG 日志相关的功能介绍、采集方法。

功能概述

API 网关（API Gateway，APIG）是一款高扩展、高可用的云上网关托管服务。APIG 基于火山引擎日志服务 TLS，为您提供持久化存储的用户访问日志，便于业务观测客户端、网关、后端服务的行为，满足排障、审计等需求。

API 网关支持自动创建默认日志主题，如需使用您自己的日志主题，请提前创建。

相关配置如下：

配置	说明
日志类型	APIG 访问日志。
日志存储位置	管理日志资源，详情请参考管理 APIG 日志资源。日志项目：自定义日志主题：默认配置：选择默认配置，网关将在当前项目下自动生成名称为网关 id-access-log的主题。使用已有主题：选择使用已创建的日志主题。
日志存储时长	默认为 90 天。
日志分区	预设 1 个分区。默认开启自动分裂日志主题分区，在写入流量较大时分裂分区以满足数据写入需求。
索引设置	自动配置索引。不支持修改索引。
日志字段	详细的日志字段列表请参考 APIG 日志字段。

采集 APIG 日志

APIG 日志字段

网关日志字段说明如下：

字段名	字段类型	字段说明
__time__	long	日志产生的时间。
gateway_id	string	网关实例 ID。
authority	string	请求报文中的 Host Header。
bytes_received	long	请求的 Body 大小（不包含 Header）。
bytes_sent	long	响应的 Body 大小（不包含 Header）。
downstream_local_address	string	网关 Pod 地址。
downstream_remote_address	string	连接到网关的 Client 端地址。
duration	long	请求整体耗时。单位为毫秒。
method	string	HTTP 方法。
path	string	HTTP 请求中的 Path。
protocol	string	HTTP 的协议版本。
request_id	string	网关会为每次请求产生一个 ID，并放在 Header 的 x-request-id 中，后端可以根据这个字段记录并进行排查。
requested_server_name	string	SSL 连接时使用的 Server Name。
response_code	long	HTTP 响应的状态码。
response_flags	string	响应失败的原因。
route_name	string	路由名。
start_time	string	请求开始时间。格式：UTC。
trace_id	string	Trace ID。
upstream_cluster	string	上游集群。
upstream_host	string	上游 IP。
upstream_local_address	string	本地连接上游的地址。
upstream_service_time	long	上游服务处理请求的耗时（毫秒），包括网关访问上游服务的网络耗时和上游服务自身处理耗时两部分。
upstream_transport_failure_reason	string	上游链接失败的原因。
user_agent	string	HTTP Header 中的 UserAgent。
x_forwarded_for	string	HTTP Header中的 x-forwarded-for，通常用来表示 HTTP 请求端真实 IP。

最近更新时间：2026.02.03 14:53:41

这个页面对您有帮助吗？

有用

无用