You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/03/17 06:49:43 UTC
[GitHub] [pulsar] gaoran10 opened a new pull request #14729: [Client] Support Reader Interceptor
gaoran10 opened a new pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729
Fix #14642
### Motivation
Currently, the Pulsar [PIP-23](https://github.com/apache/pulsar/wiki/PIP-23%3A-Message-Tracing-By-Interceptors) support adds interceptors for producers and consumers to implement message tracing, but it didn't support adding interceptors for readers, this PR wants to support adding interceptors for readers.
Because the Pulsar reader is based on the Pulsar consumer, we could leverage consumer interceptor to implement reader interceptor, use consumer interceptor to wrap reader interceptor, the reader interceptor events should be a subset of the consumer interceptors.
### Modifications
1. Add a new interface `ReaderInterceptor`, it used to cutomise reader interceptor.
2. Add a `ReaderInterceptor` list in `ReaderConfigurationData` to transport `ReaderInterceptor` list to Reader.
3. Add auto update partition configurations in `ReaderConfigurationData`.
4. Support set reader interceptor by `ReaderBuilder`.
### Verifying this change
Add ReaderInterceptor test.
### Does this pull request potentially affect one of the following parts:
*If `yes` was chosen, please highlight the changes*
- Dependencies (does it add or upgrade a dependency): (no)
- The public API: (yes)
- The schema: (no)
- The default values of configurations: (no)
- The wire protocol: (no)
- The rest endpoints: (no)
- The admin cli options: (no)
- Anything that affects deployment: (no)
### Documentation
Check the box below or label this PR directly (if you have committer privilege).
Need to update docs?
- [*] `doc-required`
(If you need help on updating docs, create a doc issue)
- [ ] `no-need-doc`
(Please explain why)
- [ ] `doc`
(If this PR contains doc changes)
--
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
[GitHub] [pulsar] Technoboy- commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Technoboy- commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829074505
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderInterceptorUtil.java
##########
@@ -0,0 +1,89 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import org.apache.pulsar.client.api.Consumer;
+import org.apache.pulsar.client.api.ConsumerInterceptor;
+import org.apache.pulsar.client.api.Message;
+import org.apache.pulsar.client.api.MessageId;
+import org.apache.pulsar.client.api.Reader;
+import org.apache.pulsar.client.api.ReaderInterceptor;
+
+
+/**
+ * ReaderInterceptorUtil is used to wrap ReaderInterceptor by ConsumerInterceptor.
+ */
+public class ReaderInterceptorUtil {
+
+ public static <T> ConsumerInterceptors<T> convertToConsumerInterceptors(
+ Reader<T> reader, List<ReaderInterceptor<T>> interceptorList) {
+ if (interceptorList == null || interceptorList.isEmpty()) {
+ return null;
+ }
+ List<ConsumerInterceptor<T>> consumerInterceptorList = new ArrayList<>();
+ for (ReaderInterceptor<T> readerInterceptor : interceptorList) {
Review comment:
new ArrayList<>(interceptorList.size()); is better?
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Do we need to keep this value at least 1 minute?
If user configs with 1ms, then what happens ?
--
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
[GitHub] [pulsar] Technoboy- commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Technoboy- commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829076250
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Do we need to keep this value at least 1 minute?
If user configs with 1ms, then what happens ?
--
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
[GitHub] [pulsar] gaoran10 commented on pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1071098637
@315157973 Yes, normally, we'd better separate the auto-update partition configurations to another PR, but it's a little hard to check the `onPartitionsChange` event because the default check interval is 60 seconds, the test needs to wait at least 1 minute. The change is very simple and I added a test to cover this change, maybe we could add the change in this PR.
--
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
[GitHub] [pulsar] gaoran10 commented on pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1071098637
@315157973 Yes, normally, we'd better separate the auto-update partition configurations to another PR, but it's a little hard to check the `onPartitionsChange` event because the default check interval is 60 seconds, the test needs to wait at least 1 minute. The change is very simple and I added a test to cover this change, maybe we could add the change in this PR.
--
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
[GitHub] [pulsar] Anonymitaet commented on pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1072086161
@momo-jun a soft reminder: here is a PR targeted at 2.11 w/ `doc-required` label.
--
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
[GitHub] [pulsar] codelipenghui merged pull request #14729: [feat][Java client]: Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
codelipenghui merged pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729
--
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
[GitHub] [pulsar] gaoran10 commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829280353
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderInterceptorUtil.java
##########
@@ -0,0 +1,89 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import org.apache.pulsar.client.api.Consumer;
+import org.apache.pulsar.client.api.ConsumerInterceptor;
+import org.apache.pulsar.client.api.Message;
+import org.apache.pulsar.client.api.MessageId;
+import org.apache.pulsar.client.api.Reader;
+import org.apache.pulsar.client.api.ReaderInterceptor;
+
+
+/**
+ * ReaderInterceptorUtil is used to wrap ReaderInterceptor by ConsumerInterceptor.
+ */
+public class ReaderInterceptorUtil {
+
+ public static <T> ConsumerInterceptors<T> convertToConsumerInterceptors(
+ Reader<T> reader, List<ReaderInterceptor<T>> interceptorList) {
+ if (interceptorList == null || interceptorList.isEmpty()) {
+ return null;
+ }
+ List<ConsumerInterceptor<T>> consumerInterceptorList = new ArrayList<>();
+ for (ReaderInterceptor<T> readerInterceptor : interceptorList) {
Review comment:
fix
--
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
[GitHub] [pulsar] Technoboy- commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Technoboy- commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829074505
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderInterceptorUtil.java
##########
@@ -0,0 +1,89 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import org.apache.pulsar.client.api.Consumer;
+import org.apache.pulsar.client.api.ConsumerInterceptor;
+import org.apache.pulsar.client.api.Message;
+import org.apache.pulsar.client.api.MessageId;
+import org.apache.pulsar.client.api.Reader;
+import org.apache.pulsar.client.api.ReaderInterceptor;
+
+
+/**
+ * ReaderInterceptorUtil is used to wrap ReaderInterceptor by ConsumerInterceptor.
+ */
+public class ReaderInterceptorUtil {
+
+ public static <T> ConsumerInterceptors<T> convertToConsumerInterceptors(
+ Reader<T> reader, List<ReaderInterceptor<T>> interceptorList) {
+ if (interceptorList == null || interceptorList.isEmpty()) {
+ return null;
+ }
+ List<ConsumerInterceptor<T>> consumerInterceptorList = new ArrayList<>();
+ for (ReaderInterceptor<T> readerInterceptor : interceptorList) {
Review comment:
new ArrayList<>(interceptorList.size()); is better?
--
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
[GitHub] [pulsar] gaoran10 commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829281990
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Because the auto-update partition check timer task is in seconds level, I adjust the check to make sure the interval should be >= 1 second.
--
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
[GitHub] [pulsar] Anonymitaet commented on pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1072086161
@momo-jun a soft reminder: here is a PR targeted at 2.11 w/ `doc-required` label.
--
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
[GitHub] [pulsar] codelipenghui merged pull request #14729: [feat][Java client]: Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
codelipenghui merged pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729
--
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
[GitHub] [pulsar] gaoran10 commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829281990
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Because the auto-update partition check timer task is in seconds level, I adjust the check to make sure the interval should be >= 1 second, please check again.
--
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
[GitHub] [pulsar] gaoran10 commented on a change in pull request #14729: [Client] Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
gaoran10 commented on a change in pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#discussion_r829280353
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderInterceptorUtil.java
##########
@@ -0,0 +1,89 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import org.apache.pulsar.client.api.Consumer;
+import org.apache.pulsar.client.api.ConsumerInterceptor;
+import org.apache.pulsar.client.api.Message;
+import org.apache.pulsar.client.api.MessageId;
+import org.apache.pulsar.client.api.Reader;
+import org.apache.pulsar.client.api.ReaderInterceptor;
+
+
+/**
+ * ReaderInterceptorUtil is used to wrap ReaderInterceptor by ConsumerInterceptor.
+ */
+public class ReaderInterceptorUtil {
+
+ public static <T> ConsumerInterceptors<T> convertToConsumerInterceptors(
+ Reader<T> reader, List<ReaderInterceptor<T>> interceptorList) {
+ if (interceptorList == null || interceptorList.isEmpty()) {
+ return null;
+ }
+ List<ConsumerInterceptor<T>> consumerInterceptorList = new ArrayList<>();
+ for (ReaderInterceptor<T> readerInterceptor : interceptorList) {
Review comment:
fix
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Because the auto-update partition check timer task is in seconds level, I adjust the check to make sure the interval should be >= 1 second.
##########
File path: pulsar-client/src/main/java/org/apache/pulsar/client/impl/ReaderBuilderImpl.java
##########
@@ -229,4 +230,26 @@ private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData<T> co
conf.setPoolMessages(poolMessages);
return this;
}
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate) {
+ this.conf.setAutoUpdatePartitions(autoUpdate);
+ return this;
+ }
+
+ @Override
+ public ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
+ checkArgument(interval > 0, "interval needs to be > 0");
Review comment:
Because the auto-update partition check timer task is in seconds level, I adjust the check to make sure the interval should be >= 1 second, please check again.
--
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
[GitHub] [pulsar] momo-jun commented on pull request #14729: [feat][Java client]: Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
momo-jun commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1074773333
> @momo-jun a soft reminder: this PR is merged, doc work can be started, thanks.
@gaoran10 will start to work on a draft as soon as he cleaned up his ongoing tasks.
--
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
[GitHub] [pulsar] Anonymitaet commented on pull request #14729: [feat][Java client]: Support Reader Interceptor
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14729:
URL: https://github.com/apache/pulsar/pull/14729#issuecomment-1074667936
@momo-jun a soft reminder: this PR is merged, doc work can be started, 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