Skip to content

Commit 025063e

Browse files
garyrussellwilkinsona
authored andcommitted
Polish Kafka Properties Docs
There are 4 client types but there were a couple of places where not all client types were mentioned (such as 'applies to producers, consumers and admins'). See gh-36032
1 parent 2cde94e commit 025063e

File tree

1 file changed

+5
-3
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging

1 file changed

+5
-3
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,14 @@ The properties supported by auto configuration are shown in the <<application-pr
7878
Note that, for the most part, these properties (hyphenated or camelCase) map directly to the Apache Kafka dotted properties.
7979
See the Apache Kafka documentation for details.
8080

81-
The first few of these properties apply to all components (producers, consumers, admins, and streams) but can be specified at the component level if you wish to use different values.
81+
Common properties (that don't include a client type in the name: `producer`, `consumer`, `admin`, or `streams`) apply to all clients.
82+
Most of these common values can be overridden for one or more of the component types, if needed.
83+
8284
Apache Kafka designates properties with an importance of HIGH, MEDIUM, or LOW.
8385
Spring Boot auto-configuration supports all HIGH importance properties, some selected MEDIUM and LOW properties, and any properties that do not have a default value.
8486

8587
Only a subset of the properties supported by Kafka are available directly through the `KafkaProperties` class.
86-
If you wish to configure the producer or consumer with additional properties that are not directly supported, use the following properties:
88+
If you wish to configure the individual client types with additional properties that are not directly supported, use the following properties:
8789

8890
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
8991
----
@@ -105,7 +107,7 @@ If you wish to configure the producer or consumer with additional properties tha
105107
"[prop.five]": "fifth"
106108
----
107109

108-
This sets the common `prop.one` Kafka property to `first` (applies to producers, consumers and admins), the `prop.two` admin property to `second`, the `prop.three` consumer property to `third`, the `prop.four` producer property to `fourth` and the `prop.five` streams property to `fifth`.
110+
This sets the common `prop.one` Kafka property to `first` (applies to producers, consumers, admins and streams), the `prop.two` admin property to `second`, the `prop.three` consumer property to `third`, the `prop.four` producer property to `fourth` and the `prop.five` streams property to `fifth`.
109111

110112
You can also configure the Spring Kafka `JsonDeserializer` as follows:
111113

0 commit comments

Comments
 (0)