Skip to content

Commit be516a4

Browse files
committed
spring-projectsGH-3001: add section to reference documentation
1 parent 2271724 commit be516a4

File tree

2 files changed

+36
-18
lines changed

2 files changed

+36
-18
lines changed

spring-kafka-docs/src/main/antora/modules/ROOT/pages/kafka/connecting.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,37 @@ These listeners can be used, for example, to create and bind a Micrometer `Kafka
5858

5959
The framework provides listeners that do exactly that; see xref:kafka/micrometer.adoc#micrometer-native[Micrometer Native Metrics].
6060

61+
[[default-client-id-prefixes]]
62+
== Default client ID prefixes
63+
64+
Starting with version 3.2, for Spring Boot applications which define an application name using the `spring.application.name` property, this name is now used
65+
as a default prefix for auto-generated client IDs for these client types:
66+
67+
- consumer clients which don't use a consumer group
68+
- producer clients
69+
- admin clients
70+
71+
This makes it easier to identify these clients at server side for troubleshooting or applying quotas.
72+
73+
.Example client ids resulting for a Spring Boot application with `spring.application.name=myapp`
74+
[%autowidth]
75+
|===
76+
|Client Type |Without application name |With application name
77+
78+
|consumer without consumer group
79+
|consumer-null-1
80+
|myapp-consumer-1
81+
82+
|consumer with consumer group "mygroup"
83+
|consumer-mygroup-1
84+
|consumer-mygroup-1
85+
86+
|producer
87+
|producer-1
88+
|myapp-producer-1
89+
90+
|admin
91+
|adminclient-1
92+
|myapp-admin-1
93+
|===
94+

spring-kafka-docs/src/main/antora/modules/ROOT/pages/whats-new.adoc

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -70,27 +70,11 @@ See xref:kafka/seek.adoc#seek[Seek API Docs] for more details.
7070
[[x32-default-clientid-prefix]]
7171
=== Spring Boot application name as default client ID prefix
7272

73-
For Spring Boot applications which define an application name using the `spring.application.name` property, this name is now used
73+
For Spring Boot applications which define an application name, this name is now used
7474
as a default prefix for auto-generated client IDs for these client types:
7575

7676
- consumer clients which don't use a consumer group
7777
- producer clients
7878
- admin clients
7979

80-
.Example client ids resulting for a Spring Boot application with `spring.application.name=myapp`
81-
[%autowidth]
82-
|===
83-
|Client Type |Before |After
84-
85-
|consumer without consumer group
86-
|consumer-null-1
87-
|myapp-consumer-1
88-
89-
|producer
90-
|producer-1
91-
|myapp-producer-1
92-
93-
|admin
94-
|adminclient-1
95-
|myapp-admin-1
96-
|===
80+
See xref:kafka/connecting.adoc#default-client-id-prefixes[Default client ID prefixes] for more details.

0 commit comments

Comments
 (0)