文档中心

SDK 配置说明

最近更新时间：2023.07.20 21:24:36

首次发布时间：2022.01.28 15:16:00

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

配置文件模板

下载 Demo 并解压缩到本地后，在路径 {DemoPath}/config/config_templete.json 中查看配置文件模板。

{
  "bootstrap.servers": "127.0.0.1:8092",
  "security.protocol": "PLAINTEXT",
  "debug": false,
  "topic": "my-topic",
  "producer": {
    "acks": "1",
    "batch.size": "16384"
  },
  "consumer": {
    "group.id": "test",
    "auto.offset.reset": "earliest",
    "enable.auto.commit": true
  },
  "sasl": {
    "enabled": false,
    "mechanism": "PLAIN",
    "username": "test-user",
    "password": "test-password"
  }
}

参数说明

参数名称	是否必选	默认值	描述
bootstrap.servers	必选	`kafka-****.kafka.ivolces.com:9092`	Kafka 实例的接入点。请在控制台实例详情页面接入点区域中查看接入点信息。
security.protocol	可选	PLAINTEXT	Kafka 实例接入点的信道认证机制。 PLAINTEXT：使用默认接入点。 SASL_PLAINTEXT：使用 SASL_PLAINTEXT 接入点。 SASL_SSL：使用 SASL_SSL 接入点。
debug	可选	false	开启 DEBUG 模式将会输出 Kafka 的运行日志。
topic	必选	topictest	消息发送与接收的 Topic 名称。请在指定实例的Topic管理页签中查看 Topic 信息。
producer.acks	可选	1	生产可靠性配置。 0：Kafka 服务侧不会返回写入结果，不能保证消息写入。 1：服务侧在消息写入一个副本后返回写入成功。 -1：服务侧在消息写入所有同步副本后返回写入成功。按照 [0, 1, -1] 的配置顺序，性能依次下降，可靠性依次增加。
producer.batch.size	可选	16384	批量发送消息的大小。在客户端消息较大或者客户端消息发送较快时可考虑加大此值。
consumer.group.id	必选	grouptest	消费消息时，指定的消费组名称。建议取业务相关的名称，便于区分。消费组可用于实现广播和单播的能力。正常情况下，一条消息只会被一个消费组消费一次，但是可以被多个消费组消费多次。
consumer.auto.offset.reset	可选	earliest	当消费组没有合法的消费记录时，使用此配置对消费进度进行重置。例如：服务侧未找到消费组的消费记录或记录的消费进度已失效。 earliest：重置消费进度到最早的一条消息。 latest：重置消费进度到最新的一条消息。可以用于新的消费组跳过历史数据。
consumer.enable.auto.commit	可选	true	是否开启自动提交消费进度。开启后，无需调用消费进度的提交方法也可将消费进度保存到服务侧。建议生产环境使用关闭自动提交，在确定处理成功后选择合适的时机手动提交消费进度，避免自动提交处理失败的消息。
sasl.enabled	可选	false	是否开启 SASL 认证。 true：开启 SASL 认证。适用于 SASL 接入点接入的场景。 false：关闭 SASL 认证。适用于默认接入点接入的场景。
sasl.mechanism	可选	PLAIN	SASL 认证算法类型，使用 SASL 接入点时必选。 PLAIN：PLAIN 机制。 SCRAM-SHA-256：SCRAM 机制。
sasl.username	可选		SASL 认证的账号名，使用 SASL 接入点时必选。请根据客户端认证机制，填写对应类型用户的用户名及密码进行进行 SASL 认证，例如在 PLAIN 机制下使用 PLAIN 用户的用户名及密码。
sasl.password	可选		SASL 认证的账号密码，使用 SASL 接入点时必选。根据客户端认证机制，填写对应类型用户的用户名及密码进行进行 SASL 认证，例如在 PLAIN 机制下使用 PLAIN 用户的用户名及密码。

配置文件模板

参数说明