Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -362,11 +362,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
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 @@ -416,6 +417,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