[improve][doc] Clarify producer name uniqueness and Key_Shared batching requirements#1093
Merged
lhotari merged 2 commits intoapache:mainfrom Mar 17, 2026
Conversation
00185f7 to
c7577b9
Compare
lhotari
approved these changes
Mar 17, 2026
Member
lhotari
left a comment
There was a problem hiding this comment.
LGTM, great work @kevin-pan-skydio
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
While working with Pulsar, I noticed a couple of areas where the docs could be
a bit more explicit to help new users avoid common pitfalls:
Producer name uniqueness — The existing docs mention producer names but
don't prominently call out that explicitly assigned names must be unique per topic.
Adding this detail up front can save users some head-scratching.
Key_Shared batching requirement — The docs do cover the need for
key-based batching with Key_Shared subscriptions, but this information
lives fairly deep in the section. A brief note near the top of the
Key_Shared description could help users discover this requirement sooner.
Modifications
docs/concepts-messaging.md— Expanded the producer name description inthe message components table. Added a note near the top of the Key_Shared
section linking to the existing batching details below.
docs/concepts-clients.md— Added a short "Producer naming" subsectioncovering uniqueness, auto-generation, and when explicit names are helpful.
docs/client-libraries-producers.md— Added a "Producer naming"subsection with code examples (Java, C++, Python) and a note that meaningful
names help with debugging.
docs/client-libraries-consumers.md— Added a brief note at the top ofthe Key_shared consumer section pointing out the producer-side batching
requirement.
Documentation
doc-requiredMatching
No code changes. Documentation only.