Skip to content

[ISSUE #10710] Sanitize lite offline Settings failure logs #10712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Aias00 wants to merge 1 commit into from
+53 −1
Closed

[ISSUE #10710] Sanitize lite offline Settings failure logs #10712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion proxy/src/main/java/org/apache/rocketmq/proxy/grpc/v2/common/GrpcClientSettingsManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import apache.rocketmq.v2.ExponentialBackoff;
import apache.rocketmq.v2.Metric;
import apache.rocketmq.v2.Settings;
import apache.rocketmq.v2.Subscription;
import com.google.protobuf.Duration;
import com.google.protobuf.util.Durations;
import java.util.Arrays;
Expand Down Expand Up @@ -253,10 +254,32 @@ public void offlineClientLiteSubscription(ProxyContext ctx, String clientId, Set
}
});
} catch (Exception e) {
log.error("offlineClientLiteSubscription error, clientId:{}, settings:{}", clientId, settings, e);
log.error("offlineClientLiteSubscription error, clientId:{}, settings:{}",
clientId, summarizeLiteSettings(settings), e);
}
}

protected static String summarizeLiteSettings(Settings settings) {
if (settings == null) {
return "null";
}
String group = "";
String topic = "";
int subscriptionCount = 0;
if (settings.hasSubscription()) {
Subscription subscription = settings.getSubscription();
group = subscription.getGroup().getName();
subscriptionCount = subscription.getSubscriptionsCount();
if (subscriptionCount > 0) {
topic = subscription.getSubscriptions(0).getTopic().getName();
}
}
return "clientType:" + settings.getClientType()
+ ", group:" + group
+ ", topic:" + topic
+ ", subscriptionCount:" + subscriptionCount;
}

@Override
public void run() {
while (!this.isStopped()) {
Expand Down
29 changes: 29 additions & 0 deletions ...src/test/java/org/apache/rocketmq/proxy/grpc/v2/common/GrpcClientSettingsManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import apache.rocketmq.v2.ClientType;
import apache.rocketmq.v2.CustomizedBackoff;
import apache.rocketmq.v2.ExponentialBackoff;
import apache.rocketmq.v2.FilterExpression;
import apache.rocketmq.v2.Publishing;
import apache.rocketmq.v2.Resource;
import apache.rocketmq.v2.RetryPolicy;
Expand All @@ -40,8 +41,10 @@
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.ArgumentMatchers.anyString;
Expand Down Expand Up @@ -201,4 +204,30 @@ public void testOfflineClientLiteSubscription_ValidLiteConsumer_SyncThrowsExcept

verify(messagingProcessor, times(1)).syncLiteSubscription(any(), any(LiteSubscriptionDTO.class), anyLong());
}

@Test
public void testSummarizeLiteSettingsDoesNotLeakSubscriptionDetails() {
Settings settings = Settings.newBuilder()
.setClientType(ClientType.LITE_PUSH_CONSUMER)
.setSubscription(Subscription.newBuilder()
.setGroup(Resource.newBuilder().setName("testGroup").build())
.addSubscriptions(SubscriptionEntry.newBuilder()
.setTopic(Resource.newBuilder().setName("testTopic").build())
.setExpression(FilterExpression.newBuilder().setExpression("sensitive-filter").build())
.build())
.addSubscriptions(SubscriptionEntry.newBuilder()
.setTopic(Resource.newBuilder().setName("otherTopic").build())
.build())
.build())
.build();

String summary = GrpcClientSettingsManager.summarizeLiteSettings(settings);

assertTrue(summary.contains("clientType:LITE_PUSH_CONSUMER"));
assertTrue(summary.contains("group:testGroup"));
assertTrue(summary.contains("topic:testTopic"));
assertTrue(summary.contains("subscriptionCount:2"));
assertFalse(summary.contains("sensitive-filter"));
assertFalse(summary.contains("otherTopic"));
}
}
Loading