RATIS-2068. Avoid logging raw StateMachine data body.#1074
Merged
szetszwo merged 5 commits intoapache:masterfrom May 3, 2024
Merged
RATIS-2068. Avoid logging raw StateMachine data body.#1074szetszwo merged 5 commits intoapache:masterfrom
szetszwo merged 5 commits intoapache:masterfrom
Conversation
szetszwo
reviewed
May 2, 2024
Contributor
szetszwo
left a comment
szetszwo
left a comment
There was a problem hiding this comment.
@duongkame , thanks a lot for fixing this! Please see the comments inlined and also https://issues.apache.org/jira/secure/attachment/13068605/1074_review.patch
| @Override | ||
| String requestToString(AppendEntriesRequestProto request) { | ||
| return ServerStringUtils.toAppendEntriesRequestString(request); | ||
| return ServerStringUtils.toAppendEntriesRequestString(request, e -> ""); |
Contributor
There was a problem hiding this comment.
Let's pass null. The code currently can handle null.
BTW, could you also update stateMachineLogEntryProtoToString(..) to print only sizes and
toLogEntryString(..) to use stateMachineLogEntryProtoToString(..)?
@@ -70,7 +70,11 @@ public final class LogProtoUtils {
}
static String stateMachineLogEntryProtoToString(StateMachineLogEntryProto p) {
- return "logData:" + p.getLogData() + ", stateMachineEntry:" + p.getType() + ":" + p.getStateMachineEntry();
+ final StateMachineEntryProto stateMachineEntry = p.getStateMachineEntry();
+ return p.getType()
+ + ": logData.size=" + p.getLogData().size()
+ + ", stateMachineData.size=" + stateMachineEntry.getStateMachineData().size()
+ + ", logEntryProtoSerializedSize=" + stateMachineEntry.getLogEntryProtoSerializedSize();
} @@ -46,9 +45,10 @@ public final class LogProtoUtils {
}
final String s;
if (entry.hasStateMachineLogEntry()) {
- s = ", " + Optional.ofNullable(function)
- .orElseGet(() -> proto -> "" + ClientInvocationId.valueOf(proto))
- .apply(entry.getStateMachineLogEntry());
+ if (function == null) {
+ function = LogProtoUtils::stateMachineLogEntryProtoToString;
+ }
+ s = ", " + function.apply(entry.getStateMachineLogEntry());
} else if (entry.hasMetadataEntry()) {
final MetadataProto metadata = entry.getMetadataEntry();
s = "(c:" + metadata.getCommitIndex() + ")";| private final long purgePreservation; | ||
|
|
||
| private final AtomicReference<LogEntryProto> lastMetadataEntry = new AtomicReference<>(); | ||
| private final Function<StateMachineLogEntryProto, String> stateMachineToString; |
Contributor
There was a problem hiding this comment.
Let don't add StateMachine dependency RaftLogBase . The subclasses can override toLogEntryString(..).
Comment on lines
+202
to
+214
| LOG.error(name + ": Failed to write log entry " + LogProtoUtils.toLogEntryString(e), t); | ||
| LOG.error(name + ": Failed to write log entry " + toString(e), t); | ||
| } else if (returned != nextIndex) { | ||
| LOG.error("{}: Indices mismatched: returned index={} but nextIndex={} for log entry {}", | ||
| name, returned, nextIndex, LogProtoUtils.toLogEntryString(e)); | ||
| name, returned, nextIndex, toString(e)); |
Contributor
There was a problem hiding this comment.
Use this.toLogEntryString(..).
Comment on lines
-539
to
-541
| public String toLogEntryString(LogEntryProto logEntry) { | ||
| return LogProtoUtils.toLogEntryString(logEntry); | ||
| } |
| } catch (Exception e) { | ||
| final String err = getName() + ": Failed readStateMachineData for " + | ||
| LogProtoUtils.toLogEntryString(entry); | ||
| final String err = getName() + ": Failed readStateMachineData for " + toString(entry); |
Contributor
There was a problem hiding this comment.
Use this.toLogEntryString(..).
| return write.getFuture().whenComplete((clientReply, exception) -> appendEntryTimerContext.stop()); | ||
| } catch (Exception e) { | ||
| LOG.error("{}: Failed to append {}", getName(), LogProtoUtils.toLogEntryString(entry), e); | ||
| LOG.error("{}: Failed to append {}", getName(), toString(entry), e); |
Contributor
There was a problem hiding this comment.
Use this.toLogEntryString(..).
Contributor
Author
Thanks for the quick review @szetszwo . Updated the PR. |
szetszwo
approved these changes
May 3, 2024
Contributor
szetszwo
left a comment
szetszwo
left a comment
There was a problem hiding this comment.
+1 the change looks good.
szetszwo
pushed a commit
to szetszwo/ratis
that referenced
this pull request
Jun 16, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
See RATIS-2068.
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/RATIS-2068
How was this patch tested?
CI