Skip to content

[ISSUE #10718] Summarize removed client settings logs #10719

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

Open
Aias00 wants to merge 1 commit into
base: develop
Choose a base branch
from
+45 −1
Open

[ISSUE #10718] Summarize removed client settings logs #10719

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
13 changes: 12 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 @@ -282,7 +282,8 @@ protected void onWaitEnd() {
consumerGroup
);
if (consumerGroupInfo == null || consumerGroupInfo.findChannel(clientId) == null) {
log.info("remove unused grpc client settings. group:{}, settings:{}", consumerGroupInfo, settings);
log.info("remove unused grpc client settings. group:{}, clientId:{}, settingsSummary:{}",
consumerGroup, clientId, summarizeClientSettings(settings));
return null;
}
return settings;
Expand All @@ -292,4 +293,14 @@ protected void onWaitEnd() {
}
}
}

static String summarizeClientSettings(Settings settings) {
if (settings == null) {
return "null";
}
int publishingTopicCount = settings.hasPublishing() ? settings.getPublishing().getTopicsCount() : 0;
int subscriptionCount = settings.hasSubscription() ? settings.getSubscription().getSubscriptionsCount() : 0;
return String.format("clientType=%s, publishingTopicCount=%d, subscriptionCount=%d",
settings.getClientType(), publishingTopicCount, subscriptionCount);
}
}
33 changes: 33 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 @@ -40,8 +40,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 @@ -156,6 +158,37 @@ public void testOfflineClientLiteSubscription_SettingsNotNull_NotLiteConsumer()
verify(messagingProcessor, never()).syncLiteSubscription(any(), any(), anyLong());
}

@Test
public void testSummarizeClientSettingsDoesNotExposeResourceNames() {
Settings producerSettings = Settings.newBuilder()
.setClientType(ClientType.PRODUCER)
.setPublishing(Publishing.newBuilder()
.addTopics(Resource.newBuilder().setName("sensitive-publish-topic").build())
.build())
.build();
Settings consumerSettings = Settings.newBuilder()
.setClientType(ClientType.PUSH_CONSUMER)
.setSubscription(Subscription.newBuilder()
.setGroup(Resource.newBuilder().setName("sensitive-group").build())
.addSubscriptions(SubscriptionEntry.newBuilder()
.setTopic(Resource.newBuilder().setName("sensitive-subscription-topic").build())
.build())
.build())
.build();

String producerSummary = GrpcClientSettingsManager.summarizeClientSettings(producerSettings);
String consumerSummary = GrpcClientSettingsManager.summarizeClientSettings(consumerSettings);

assertTrue(producerSummary.contains("clientType=PRODUCER"));
assertTrue(producerSummary.contains("publishingTopicCount=1"));
assertFalse(producerSummary.contains("sensitive-publish-topic"));

assertTrue(consumerSummary.contains("clientType=PUSH_CONSUMER"));
assertTrue(consumerSummary.contains("subscriptionCount=1"));
assertFalse(consumerSummary.contains("sensitive-subscription-topic"));
assertFalse(consumerSummary.contains("sensitive-group"));
}

@Test
public void testOfflineClientLiteSubscription_ValidLiteConsumer_Success() {
Subscription subscription = Subscription.newBuilder()
Expand Down
Loading