You need to enable JavaScript to run this app.
导航
配置文件
最近更新时间:2023.12.14 20:52:45首次发布时间:2022.01.28 15:16:00

火山引擎消息队列 Kafka版为您提供示例项目 Demo 供您快速接入和体验。本文介绍配置文件 config.properties的常用参数配置。

配置文件模板

下载 Demo 并解压缩到本地后,在路径 {DemoPath}/src/main/resources 中查看配置文件模板 config.propertiesssl.config.properties

说明

实际场景下填写配置文件时,应删除所有注释语句。

## 接入点,通过控制台获取
bootstrap.servers=xxxxx
// 安全协议: PLAINTEXT, SASL_PLAINTEXT
security.protocol=PLAINTEXT
topic=my-topic
consumer.group.id=test
consumer.auto.offset.reset=earliest
consumer.enable.auto.commit=false
client.dns.lookup=use_all_dns_ips
// 客户端认证机制: PLAIN, SCRAM-SHA-256
sasl.mechanism=PLAIN
sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username="xxxx" password="xxxxx";
#org.apache.kafka.common.security.scram.ScramLoginModule required username="xxxx" password="xxxxx";

参数说明

参数名称

是否必选

默认值

描述

bootstrap.servers

必选

kafka-xx.kafka.ivolces.com:xxxx

Kafka 实例的接入点。
请在控制台实例详情页面接入点区域中查看接入点信息。

security.protocol

可选

PLAINTEXT

Kafka 实例接入点的信道认证机制。

  • PLAINTEXT:使用默认接入点。
  • SASL_PLAINTEXT:使用 SASL 接入点。

topic

必选

topictest

消息发送与接收的 Topic 名称。
请在指定实例的Topic管理页签中查看 Topic 信息。

consumer.group.id

必选

grouptest

消费消息时,指定的消费组名称。建议取业务相关的名称,便于区分。消费组可用于实现广播和单播的能力。正常情况下,一条消息只会被一个消费组消费一次,但是可以被多个消费组消费多次。

consumer.auto.offset.reset

可选

earliest

当消费组没有合法的消费记录时,使用此配置对消费进度进行重置。例如:服务侧未找到消费组的消费记录或记录的消费进度已失效。

  • earliest:重置消费进度到最早的一条消息。
  • latest:重置消费进度到最新的一条消息。可以用于新的消费组跳过历史数据。

consumer.enable.auto.commit

可选

true

是否开启自动提交消费进度。开启后,无需调用消费进度的提交方法也可将消费进度保存到服务侧。
建议生产环境使用关闭自动提交,在确定处理成功后选择合适的时机手动提交消费进度,避免自动提交处理失败的消息。

sasl.mechanism

可选

PLAIN

SASL 认证算法类型,使用 SASL 接入点时必选。

  • PLAIN:PLAIN 机制。
  • SCRAM-SHA-256:SCRAM 机制。

sasl.jaas.config

可选

SASL 认证信息,包括的账号名和账号密码,使用 SASL 接入点时必选。

说明

请根据客户端认证机制,填写对应类型用户的用户名及密码进行进行 SASL 认证,例如在 PLAIN 机制下使用 PLAIN 用户的用户名及密码。

client.dns.lookup

可选

指定 Kafka 客户端通过 DNS 解析域名的方式。

  • use_all_dns_ips:尝试连接每个返回的 IP 地址,直到成功建立连接。2.7 及以上版本客户端默认为 use_all_dns_ips。
  • default:只会使用 DNS 返回多个 IP 地址中的第一个,如果第一个 IP 不可用,则一直无法连接。2.7 以下版本客户端默认为 default。