You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "RobertIndie (via GitHub)" <gi...@apache.org> on 2024/07/25 03:07:31 UTC
[PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
RobertIndie opened a new pull request, #23075:
URL: https://github.com/apache/pulsar/pull/23075
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
-->
### Motivation
Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
the client configuration. The client can then send these properties to the broker during the lookup process.
Here is a scenario for using the client properties for the lookup:
Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
broker to identify and connect them to the nearest broker within the same rack. If a client that configures the "rack"
property with "A" connects to a lookup broker, the customized load manager can determine broker-0 as the owner broker
since the broker and the client have the same rack property.
### Modifications
Add new configuration `properties` to the client. While looking up the broker, the client will send the properties to
the broker through `CommandLookupTopic` request.
The `properties` will be added to the `LookupOptions`. The Load Manager implementation can retrieve the `properties`
through `LookupOptions` to make a better decision on which broker to return.
The properties are used only when the protocol is the binary protocol, starting with `pulsar://` or `pulsar+ssl://`, or
if the `loadManagerClassName` in the broker is a class that implements the `ExtensibleLoadManager` interface.
### Does this pull request potentially affect one of the following parts:
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed in
a forked repository.
The tests will be run in the forked repository until all PR review comments have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "RobertIndie (via GitHub)" <gi...@apache.org>.
RobertIndie commented on code in PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#discussion_r1696765905
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
+broker to identify and connect them to the nearest broker within the same rack. If a client that configures the "rack"
+property with "A" connects to a lookup broker, the customized load manager can determine broker-0 as the owner broker
+since the broker and the client have the same rack property.
+
+# Goals
+
+## In Scope
+
+- Enable clients to send additional lookup information to brokers during the lookup.
+
+## Out of Scope
+
+None
+
+# High Level Design
+
+Add new configuration `properties` to the client. While looking up the broker, the client will send the properties to
+the broker through `CommandLookupTopic` request.
+The `properties` will be added to the `LookupOptions`. The Load Manager implementation can retrieve the `properties`
+through `LookupOptions` to make a better decision on which broker to return.
+The properties are used only when the protocol is the binary protocol, starting with `pulsar://` or `pulsar+ssl://`, or
+if the `loadManagerClassName` in the broker is a class that implements the `ExtensibleLoadManager` interface.
+
+# Detailed Design
+
+## Design & Implementation Details
+
+## Public-facing Changes
+
+### Configuration
+
+Add new configuration `properties` to the `ClientBuilder`.
+
+```java
+/**
+ * Set the properties used for topic lookup.
+ * <p>
+ * When the broker performs topic lookup, these properties will be taken into consideration in a customized load
+ * manager.
+ * <p>
+ * Note: The properties are only used in topic lookup when:
+ * - The protocol is binary protocol, i.e. the service URL starts with "pulsar://" or "pulsar+ssl://"
+ * - The `loadManagerClassName` config in broker is a class that implements the `ExtensibleLoadManager` interface
+ */
+ClientBuilder properties(Map<String, String> properties);
+```
+
+### Binary protocol
+
+Add `properties` field to the `CommandLookupTopic`. Now the `CommandLookupTopic will look like:
Review Comment:
Thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "crossoverJie (via GitHub)" <gi...@apache.org>.
crossoverJie commented on code in PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#discussion_r1692420734
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
+broker to identify and connect them to the nearest broker within the same rack. If a client that configures the "rack"
+property with "A" connects to a lookup broker, the customized load manager can determine broker-0 as the owner broker
+since the broker and the client have the same rack property.
+
+# Goals
+
+## In Scope
+
+- Enable clients to send additional lookup information to brokers during the lookup.
+
+## Out of Scope
+
+None
+
+# High Level Design
+
+Add new configuration `properties` to the client. While looking up the broker, the client will send the properties to
+the broker through `CommandLookupTopic` request.
+The `properties` will be added to the `LookupOptions`. The Load Manager implementation can retrieve the `properties`
+through `LookupOptions` to make a better decision on which broker to return.
+The properties are used only when the protocol is the binary protocol, starting with `pulsar://` or `pulsar+ssl://`, or
+if the `loadManagerClassName` in the broker is a class that implements the `ExtensibleLoadManager` interface.
+
+# Detailed Design
+
+## Design & Implementation Details
+
+## Public-facing Changes
+
+### Configuration
+
+Add new configuration `properties` to the `ClientBuilder`.
+
+```java
+/**
+ * Set the properties used for topic lookup.
+ * <p>
+ * When the broker performs topic lookup, these properties will be taken into consideration in a customized load
+ * manager.
+ * <p>
+ * Note: The properties are only used in topic lookup when:
+ * - The protocol is binary protocol, i.e. the service URL starts with "pulsar://" or "pulsar+ssl://"
+ * - The `loadManagerClassName` config in broker is a class that implements the `ExtensibleLoadManager` interface
+ */
+ClientBuilder properties(Map<String, String> properties);
Review Comment:
Why not name it `lookupProperties`?
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
+broker to identify and connect them to the nearest broker within the same rack. If a client that configures the "rack"
+property with "A" connects to a lookup broker, the customized load manager can determine broker-0 as the owner broker
+since the broker and the client have the same rack property.
+
+# Goals
+
+## In Scope
+
+- Enable clients to send additional lookup information to brokers during the lookup.
+
+## Out of Scope
+
+None
+
+# High Level Design
+
+Add new configuration `properties` to the client. While looking up the broker, the client will send the properties to
+the broker through `CommandLookupTopic` request.
+The `properties` will be added to the `LookupOptions`. The Load Manager implementation can retrieve the `properties`
+through `LookupOptions` to make a better decision on which broker to return.
+The properties are used only when the protocol is the binary protocol, starting with `pulsar://` or `pulsar+ssl://`, or
+if the `loadManagerClassName` in the broker is a class that implements the `ExtensibleLoadManager` interface.
+
+# Detailed Design
+
+## Design & Implementation Details
+
+## Public-facing Changes
+
+### Configuration
+
+Add new configuration `properties` to the `ClientBuilder`.
+
+```java
+/**
+ * Set the properties used for topic lookup.
+ * <p>
+ * When the broker performs topic lookup, these properties will be taken into consideration in a customized load
+ * manager.
+ * <p>
+ * Note: The properties are only used in topic lookup when:
+ * - The protocol is binary protocol, i.e. the service URL starts with "pulsar://" or "pulsar+ssl://"
+ * - The `loadManagerClassName` config in broker is a class that implements the `ExtensibleLoadManager` interface
+ */
+ClientBuilder properties(Map<String, String> properties);
+```
+
+### Binary protocol
+
+Add `properties` field to the `CommandLookupTopic`. Now the `CommandLookupTopic will look like:
Review Comment:
Missing a sympob `CommandLookupTopic
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
Review Comment:
This part is not very familar to me, is the broker's properties not stored in the metadata?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#issuecomment-2249273364
@RobertIndie Please add the following content to your PR description and select a checkbox:
```
- [ ] `doc` <!-- Your PR contains doc changes -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "RobertIndie (via GitHub)" <gi...@apache.org>.
RobertIndie commented on code in PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#discussion_r1696764863
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
Review Comment:
Thanks. I added the support of the `lookupProperties` on the broker side. The broker lookup properties will be saved in the metadata store. So the broker can now access the lookup properties for all other brokers. This will help implement this rack-aware lookup scenario.
> is the broker's properties not stored in the metadata?
No. So I updated this proposal to make the broker properties that start with `lookupPropertyPrefix` be able to be stored in the metadata store.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "BewareMyPower (via GitHub)" <gi...@apache.org>.
BewareMyPower commented on code in PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#discussion_r1690756510
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
Review Comment:
Even if a broker configures the "rack" property, there is no way to let a broker know another broker's "rack" property.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support client properties for the lookup [pulsar]
Posted by "RobertIndie (via GitHub)" <gi...@apache.org>.
RobertIndie commented on code in PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#discussion_r1696765250
##########
pip/pip-368.md:
##########
@@ -0,0 +1,148 @@
+# PIP-368: Support client properties for the lookup
+
+# Background knowledge
+
+## How Pulsar Lookup Works
+
+Before producing or consuming messages, a Pulsar client must first find the broker responsible for the topic. This
+happens through the lookup service. The client sends a `CommandLookupTopic` request with the topic name to the lookup
+service, which then returns the responsible broker. The client then interacts with this broker to produce or consume
+messages.
+
+On the broker side, users can customize lookup logic by setting a custom load manager in the `loadManagerClassName`
+configuration.
+
+# Motivation
+
+Currently, the lookup process uses only the topic name as its parameter. However, to enhance this process, it's
+beneficial for clients to provide additional information. This could be done by introducing the `properties` field in
+the client configuration. The client can then send these properties to the broker during the lookup process.
+
+Here is a scenario for using the client properties for the lookup:
+Assuming there are two brokers that broker-0 configures the "rack" property with "A" and broker-1 configures the "rack"
+property with "B". By using the lookup properties, clients can supply rack information during the lookup, enabling the
+broker to identify and connect them to the nearest broker within the same rack. If a client that configures the "rack"
+property with "A" connects to a lookup broker, the customized load manager can determine broker-0 as the owner broker
+since the broker and the client have the same rack property.
+
+# Goals
+
+## In Scope
+
+- Enable clients to send additional lookup information to brokers during the lookup.
+
+## Out of Scope
+
+None
+
+# High Level Design
+
+Add new configuration `properties` to the client. While looking up the broker, the client will send the properties to
+the broker through `CommandLookupTopic` request.
+The `properties` will be added to the `LookupOptions`. The Load Manager implementation can retrieve the `properties`
+through `LookupOptions` to make a better decision on which broker to return.
+The properties are used only when the protocol is the binary protocol, starting with `pulsar://` or `pulsar+ssl://`, or
+if the `loadManagerClassName` in the broker is a class that implements the `ExtensibleLoadManager` interface.
+
+# Detailed Design
+
+## Design & Implementation Details
+
+## Public-facing Changes
+
+### Configuration
+
+Add new configuration `properties` to the `ClientBuilder`.
+
+```java
+/**
+ * Set the properties used for topic lookup.
+ * <p>
+ * When the broker performs topic lookup, these properties will be taken into consideration in a customized load
+ * manager.
+ * <p>
+ * Note: The properties are only used in topic lookup when:
+ * - The protocol is binary protocol, i.e. the service URL starts with "pulsar://" or "pulsar+ssl://"
+ * - The `loadManagerClassName` config in broker is a class that implements the `ExtensibleLoadManager` interface
+ */
+ClientBuilder properties(Map<String, String> properties);
Review Comment:
Good suggestions. Applied it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support lookup based on the lookup properties [pulsar]
Posted by "RobertIndie (via GitHub)" <gi...@apache.org>.
RobertIndie commented on PR #23075:
URL: https://github.com/apache/pulsar/pull/23075#issuecomment-2272491285
The vote has passed with 3 binding +1s. https://lists.apache.org/thread/z0t3dyqj27ldm8rs6nl5jon152ohghvw
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [improve][pip] PIP-368: Support lookup based on the lookup properties [pulsar]
Posted by "RobertIndie (via GitHub)" <gi...@apache.org>.
RobertIndie merged PR #23075:
URL: https://github.com/apache/pulsar/pull/23075
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org