API网关 APIG-Kafka日志推送策略说明:配置参数说明

时间：2024-10-23 17:38:10

API网关 APIG API策略

配置参数说明

表1 配置参数
参数	配置说明
策略基本信息
Broker地址	填写目标Kafka的连接地址，建立连接关系。多个地址间以英文逗号（,）隔开。
Topic主题	填写目标Kafka上报日志的主题。
Key	填写日志的Key值，表示日志存储在Kafka的指定分区，可以当成有序消息队列使用。如果Key为空，则日志分布式存储在不同的消息分区。
失败重试分配	日志推送到Kafka失败后的重试配置。重试次数：失败后的重试次数，范围为0-5次。重试间隔时间：失败后的重试时间间隔，范围为1-10秒。
SASL配置信息
安全协议	连接目标Kafka所使用的安全协议。 PLAINTEXT：默认接入点的用户认证协议。 SASL_PLAINTEXT：SASL用户认证协议。 SASL_SSL：SSL用户认证协议。
消息收发机制	目标Kafka的消息收发机制，默认为PLAIN。
SASL用户名	仅当“安全协议”选择“SASL_PLAINTEXT”或“SASL_SSL”时需配置。 SASL或SSL认证所使用的用户名。
SASL用户密码	仅当“安全协议”选择“SASL_PLAINTEXT”或“SASL_SSL”时需配置。 SASL或SSL认证所使用的用户密码。
确认SASL用户密码	仅当“安全协议”选择“SASL_PLAINTEXT”或“SASL_SSL”时需配置。填写与SASL用户密码一样的值。
证书内容	仅当“安全协议”选择“SASL_SSL”时需配置。 SSL认证所使用的CA证书内容。
元数据配置信息
系统元数据	推送的日志中，需要携带的系统字段信息。其中，start_time、request_id、client_ip、request_time、http_status、scheme、request_method、host、uri、upstream_addr、upstream_status、upstream_response_time、http_x_forwarded_for、http_user_agent和error_type字段信息默认在日志中携带，其他系统字段需勾选后才携带。
请求数据	推送的日志中，需要携带的API请求信息。日志包含请求头域信息：勾选后，需填写日志中要携带的请求Header参数。多个字段间使用英文逗号（,）分隔，支持使用进行通配设置。日志包含请求QueryString信息：勾选后，需填写日志中要携带的请求Query参数信息。多个字段间使用英文逗号（,）分隔，支持使用进行通配设置。日志包含请求Body体信息：勾选后，日志中会携带API请求的Body体信息。
响应数据	推送的日志中，需要携带的API响应信息。日志包含响应头域信息：勾选后，需填写日志中要携带的响应Header参数。多个字段间使用英文逗号（,）分隔，支持使用*进行通配设置。日志包含响应Body体信息：勾选后，日志中会携带响应Body体信息。
自定义认证配置	推送的日志中，需要携带的自定义认证信息。前端：填写日志中要携带的前端自定义认证的响应字段信息，多个字段间使用英文逗号（,）分隔。后端：填写日志中要携带的后端自定义认证的响应字段信息，多个字段间使用英文逗号（,）分隔。