This is an automated email from the ASF dual-hosted git repository.
mmarshall pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 65f61121e99 [cleanup] Catch TimeoutException when logging about time
outs (#20349)
65f61121e99 is described below
commit 65f61121e99b504294cf375f319f7946ff4c50fd
Author: Michael Marshall <[email protected]>
AuthorDate: Thu May 18 09:46:52 2023 -0500
[cleanup] Catch TimeoutException when logging about time outs (#20349)
Relates to: #20299
### Motivation
We have several catch blocks that are dedicated to providing meaningful
logs about timeouts. As such, we should catch the `TimeoutException`, not the
`InterruptedException`, in order to ensure accurate logs.
### Modifications
* Replace `InterruptedException` with `TimeoutException`
### Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
### Documentation
- [x] `doc-not-needed`
---
.../apache/pulsar/broker/authorization/AuthorizationService.java | 7 ++++---
.../src/main/java/org/apache/pulsar/broker/rest/TopicsBase.java | 3 ++-
.../src/main/java/org/apache/pulsar/websocket/ConsumerHandler.java | 3 ++-
.../src/main/java/org/apache/pulsar/websocket/ProducerHandler.java | 3 ++-
.../src/main/java/org/apache/pulsar/websocket/ReaderHandler.java | 3 ++-
5 files changed, 12 insertions(+), 7 deletions(-)
diff --git
a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authorization/AuthorizationService.java
b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authorization/AuthorizationService.java
index 0c61219b57a..6f303e2117f 100644
---
a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authorization/AuthorizationService.java
+++
b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/authorization/AuthorizationService.java
@@ -23,6 +23,7 @@ import java.net.SocketAddress;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeoutException;
import javax.ws.rs.core.Response;
import org.apache.commons.lang3.StringUtils;
import org.apache.pulsar.broker.PulsarServerException;
@@ -221,7 +222,7 @@ public class AuthorizationService {
try {
return canProduceAsync(topicName, role, authenticationData).get(
conf.getMetadataStoreOperationTimeoutSeconds(), SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
conf.getMetadataStoreOperationTimeoutSeconds(), topicName);
throw e;
@@ -237,7 +238,7 @@ public class AuthorizationService {
try {
return canConsumeAsync(topicName, role, authenticationData,
subscription)
.get(conf.getMetadataStoreOperationTimeoutSeconds(),
SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
conf.getMetadataStoreOperationTimeoutSeconds(), topicName);
throw e;
@@ -263,7 +264,7 @@ public class AuthorizationService {
try {
return canLookupAsync(topicName, role, authenticationData)
.get(conf.getMetadataStoreOperationTimeoutSeconds(),
SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
conf.getMetadataStoreOperationTimeoutSeconds(), topicName);
throw e;
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/rest/TopicsBase.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/rest/TopicsBase.java
index 7d3aa37fa4e..6f3ac7f8c09 100644
--- a/pulsar-broker/src/main/java/org/apache/pulsar/broker/rest/TopicsBase.java
+++ b/pulsar-broker/src/main/java/org/apache/pulsar/broker/rest/TopicsBase.java
@@ -39,6 +39,7 @@ import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeoutException;
import java.util.stream.Collectors;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.core.Response;
@@ -771,7 +772,7 @@ public class TopicsBase extends PersistentTopicsBase {
isAuthorized =
pulsar().getBrokerService().getAuthorizationService()
.allowTopicOperationAsync(topicName,
TopicOperation.PRODUCE, authParams)
.get(config().getMetadataStoreOperationTimeoutSeconds(), SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
config().getMetadataStoreOperationTimeoutSeconds(),
topicName);
throw new RestException(Status.INTERNAL_SERVER_ERROR,
"Time-out while checking authorization");
diff --git
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ConsumerHandler.java
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ConsumerHandler.java
index e326f2f02a9..2ab62b10ee9 100644
---
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ConsumerHandler.java
+++
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ConsumerHandler.java
@@ -29,6 +29,7 @@ import java.io.IOException;
import java.util.Base64;
import java.util.List;
import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLongFieldUpdater;
import java.util.concurrent.atomic.LongAdder;
@@ -476,7 +477,7 @@ public class ConsumerHandler extends
AbstractWebSocketHandler {
return service.getAuthorizationService()
.allowTopicOperationAsync(topic, TopicOperation.CONSUME,
authRole, subscription)
.get(service.getConfig().getMetadataStoreOperationTimeoutSeconds(), SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
service.getConfig().getMetadataStoreOperationTimeoutSeconds(), topic);
throw e;
diff --git
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ProducerHandler.java
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ProducerHandler.java
index f18d46e2856..5ad1283fe84 100644
---
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ProducerHandler.java
+++
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ProducerHandler.java
@@ -34,6 +34,7 @@ import java.util.Base64;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicLongFieldUpdater;
import java.util.concurrent.atomic.LongAdder;
import javax.servlet.http.HttpServletRequest;
@@ -248,7 +249,7 @@ public class ProducerHandler extends
AbstractWebSocketHandler {
return service.getAuthorizationService()
.allowTopicOperationAsync(topic, TopicOperation.PRODUCE,
authRole, authenticationData)
.get(service.getConfig().getMetadataStoreOperationTimeoutSeconds(), SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
service.getConfig().getMetadataStoreOperationTimeoutSeconds(), topic);
throw e;
diff --git
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ReaderHandler.java
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ReaderHandler.java
index 3d726b9f02f..2f985b2076d 100644
---
a/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ReaderHandler.java
+++
b/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/ReaderHandler.java
@@ -23,6 +23,7 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank;
import com.fasterxml.jackson.core.JsonProcessingException;
import java.io.IOException;
import java.util.Base64;
+import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLongFieldUpdater;
import java.util.concurrent.atomic.LongAdder;
@@ -319,7 +320,7 @@ public class ReaderHandler extends AbstractWebSocketHandler
{
return service.getAuthorizationService()
.allowTopicOperationAsync(topic, TopicOperation.CONSUME,
authRole, subscription)
.get(service.getConfig().getMetadataStoreOperationTimeoutSeconds(), SECONDS);
- } catch (InterruptedException e) {
+ } catch (TimeoutException e) {
log.warn("Time-out {} sec while checking authorization on {} ",
service.getConfig().getMetadataStoreOperationTimeoutSeconds(), topic);
throw e;
