Skip to content

Commit d9029ef

Browse files
committed
Fix documentation of spring.kafka.producer.batch-size
Closes gh-13127
1 parent 64158eb commit d9029ef

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2016 the original author or authors.
2+
* Copyright 2012-2018 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -444,7 +444,8 @@ public static class Producer {
444444
private String acks;
445445

446446
/**
447-
* Number of records to batch before sending.
447+
* Default batch size in bytes. A small batch size will make batching less common
448+
* and may reduce throughput (a batch size of zero disables batching entirely).
448449
*/
449450
private Integer batchSize;
450451

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -917,7 +917,7 @@ content into your application; rather pick only the properties that you need.
917917
spring.kafka.listener.concurrency= # Number of threads to run in the listener containers.
918918
spring.kafka.listener.poll-timeout= # Timeout in milliseconds to use when polling the consumer.
919919
spring.kafka.producer.acks= # Number of acknowledgments the producer requires the leader to have received before considering a request complete.
920-
spring.kafka.producer.batch-size= # Number of records to batch before sending.
920+
spring.kafka.producer.batch-size= # Default batch size in bytes.
921921
spring.kafka.producer.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connection to the Kafka cluster.
922922
spring.kafka.producer.buffer-memory= # Total bytes of memory the producer can use to buffer records waiting to be sent to the server.
923923
spring.kafka.producer.client-id= # Id to pass to the server when making requests; used for server-side logging.

0 commit comments

Comments
 (0)