Skip to content

fix: summarize ClientActivity telemetry and settings logs #10717

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 2 commits into
base: develop
Choose a base branch
from
+97 −2
Open

fix: summarize ClientActivity telemetry and settings logs #10717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
156b3cf
[ISSUE #10716] Summarize synced client settings logs
Aias00 Jul 31, 2026
5214e17
[ISSUE #10676] Sanitize telemetry exception logs
Aias00 Jul 29, 2026
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
43 changes: 41 additions & 2 deletions proxy/src/main/java/org/apache/rocketmq/proxy/grpc/v2/client/ClientActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ public ClientActivity(MessagingProcessor messagingProcessor,
this.init();
}

static String summarizeSettings(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);
}

protected void init() {
this.messagingProcessor.registerConsumerListener(new ConsumerIdsChangeListenerImpl());
this.messagingProcessor.registerProducerListener(new ProducerChangeListenerImpl());
Expand Down Expand Up @@ -362,11 +372,39 @@ protected void processTelemetryException(TelemetryCommand request, Throwable t,
}
}
if (exception.getStatus().getCode().equals(io.grpc.Status.Code.INTERNAL)) {
log.warn("process client telemetryCommand failed. request:{}", request, t);
log.warn("process client telemetryCommand failed. request:{}", summarizeTelemetryCommand(request), t);
}
responseObserver.onError(exception);
}

static String summarizeTelemetryCommand(TelemetryCommand request) {
if (request == null) {
return "null";
}

StringBuilder builder = new StringBuilder(request.getCommandCase().name());
if (request.hasStatus()) {
builder.append(", statusCode=").append(request.getStatus().getCode());
}
switch (request.getCommandCase()) {
case SETTINGS:
builder.append(", clientType=").append(request.getSettings().getClientType())
.append(", pubSubCase=").append(request.getSettings().getPubSubCase());
break;
case THREAD_STACK_TRACE:
builder.append(", nonce=").append(request.getThreadStackTrace().getNonce())
.append(", details omitted");
break;
case VERIFY_MESSAGE_RESULT:
builder.append(", nonce=").append(request.getVerifyMessageResult().getNonce());
break;
default:
// Add explicit cases for future telemetry requests that carry sensitive details.
break;
}
return builder.toString();
}

protected void processAndWriteClientSettings(ProxyContext ctx, TelemetryCommand request,
StreamObserver<TelemetryCommand> responseObserver) {
GrpcClientChannel grpcClientChannel = null;
Expand Down Expand Up @@ -597,7 +635,8 @@ protected void processClientRegister(String group, Object... args) {
if (ChannelHelper.isRemote(channel)) {
// save settings from channel sync from other proxy
Settings settings = GrpcClientChannel.parseChannelExtendAttribute(channel);
log.debug("save client settings sync from other proxy. group:{}, channelInfo:{}, settings:{}", group, clientChannelInfo, settings);
log.debug("save client settings sync from other proxy. group:{}, channelInfo:{}, settingsSummary:{}",
group, clientChannelInfo, summarizeSettings(settings));
if (settings == null) {
return;
}
Expand Down
56 changes: 56 additions & 0 deletions proxy/src/test/java/org/apache/rocketmq/proxy/grpc/v2/client/ClientActivityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.any;
Expand Down Expand Up @@ -184,6 +185,42 @@ protected HeartbeatResponse sendConsumerHeartbeat(ProxyContext context) throws T
.build()).get();
}

@Test
public void testSummarizeSettingsDoesNotExposeResourceNames() {
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()
.setExpression(FilterExpression.newBuilder()
.setExpression("sensitive-tag")
.setType(FilterType.TAG)
.build())
.setTopic(Resource.newBuilder().setName("sensitive-subscription-topic").build())
.build())
.build())
.build();

String producerSummary = ClientActivity.summarizeSettings(producerSettings);
String consumerSummary = ClientActivity.summarizeSettings(consumerSettings);

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

assertThat(consumerSummary).contains("clientType=PUSH_CONSUMER");
assertThat(consumerSummary).contains("subscriptionCount=1");
assertThat(consumerSummary).doesNotContain("sensitive-subscription-topic");
assertThat(consumerSummary).doesNotContain("sensitive-group");
assertThat(consumerSummary).doesNotContain("sensitive-tag");
}

@Test
public void testConsumerHeartbeat() throws Throwable {
ProxyContext context = createContext();
Expand Down Expand Up @@ -416,6 +453,25 @@ public void onCompleted() {
assertThat(result.getResult().getConsumeResult()).isEqualTo(CMResult.CR_SUCCESS);
}

@Test
public void testSummarizeTelemetryCommandDoesNotIncludeThreadStackTrace() {
TelemetryCommand command = TelemetryCommand.newBuilder()
.setThreadStackTrace(ThreadStackTrace.newBuilder()
.setNonce("nonce-1")
.setThreadStackTrace("secret-stack-trace")
.build())
.setStatus(ResponseBuilder.getInstance().buildStatus(Code.OK, Code.OK.name()))
.build();

String summary = ClientActivity.summarizeTelemetryCommand(command);

assertTrue(summary.contains("THREAD_STACK_TRACE"));
assertTrue(summary.contains("statusCode=OK"));
assertTrue(summary.contains("nonce-1"));
assertTrue(summary.contains("details omitted"));
assertFalse(summary.contains("secret-stack-trace"));
}

protected CompletableFuture<TelemetryCommand> sendClientTelemetry(ProxyContext ctx, Settings settings) {
when(grpcClientSettingsManager.getClientSettings(any())).thenReturn(settings);

Expand Down
Loading