更新时间:2022-05-05 GMT+08:00
分享

Kafka日志推送插件说明

概述

ROMA Connect支持收集服务集成下已开放API的调用日志信息。Kafka日志推送插件提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。

使用限制

  • 同一个ROMA Connect实例内最多可创建5个Kafka日志推送插件。
  • 推送的日志信息中,响应数据暂不支持Transfer Encoding响应头参数。

配置参数说明

表1 配置参数

参数

配置说明

策略基本信息

Broker地址

日志要推送的目标Kafka连接地址列表,多个地址间以英文逗号(,)隔开。

Topic主题

日志要推送的目标Kafka Topic名称。

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_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体信息。

自定义认证配置

推送的日志中,需要携带的自定义认证信息。

  • 前端:填写日志中要携带的前端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。
  • 后端:填写日志中要携带的后端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。
分享:

    相关文档

    相关产品

close