docs: document Pulsar listenerName metadata field#5236
Merged
alicejgibbons merged 3 commits intoJul 20, 2026
Conversation
Documents the listenerName field added to the Pulsar pubsub component in dapr/components-contrib#4386, which exposes the pulsar-client-go ListenerName option for advertisedListeners / multi-listener broker topologies. Ships in Dapr 1.19. Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Dapr docs for the Pulsar pub/sub component to document the newly added listenerName metadata field (shipping in Dapr 1.19), which maps to the Pulsar Go client’s ClientOptions.ListenerName and supports broker redirect resolution via named advertised listeners.
Changes:
- Adds the
listenerNamemetadata entry to the Pulsar component spec metadata table. - Includes a reference link to Pulsar’s “Multiple Advertised Listeners” documentation for additional context.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alicejgibbons
requested changes
Jul 8, 2026
alicejgibbons
left a comment
alicejgibbons
left a comment
Contributor
There was a problem hiding this comment.
Is unclear based on https://pulsar.apache.org/docs/3.0.x/concepts-multiple-advertised-listeners/
Address review feedback: distinguish the client-side listenerName (a single listener name matching one in the broker's advertisedListeners) from the broker-side advertisedListeners/internalListenerName config, note that internal/external are operator-chosen conventions rather than fixed values, and state the default. Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
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.
Description
Documents the new
listenerNamemetadata field on the Pulsar pub/sub component, added in dapr/components-contrib#4386 (merged, ships in Dapr 1.19).The field exposes the
pulsar-client-goClientOptions.ListenerNameoption. When set, the value is sent to the broker so that brokers configured withadvertisedListenersresolve connection-redirect targets using the matching named listener — enabling cross-network / multi-cluster topologies (sidecars in a separate VPC or cluster from the broker) without a Pulsar proxy. When unset, behavior is unchanged.The wording and the reference link mirror the component's
metadata.yamlentry.Issue reference
Documents the feature from dapr/components-contrib#4386 (closes dapr/components-contrib#4383).
Checklist
listenerNamerow to the Pulsar spec metadata tablev1.19(the release the feature ships in)