[RATIS-2068] Logs with entire StateMachine data is painful to read

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.0.0, 3.0.1
• Fix Version/s: 3.1.0
• Component/s: StateMachine
• Assignee: Duong
• Reporter: Duong
• Created: 01/May/24 02:41
• Updated: 03/May/24 18:49
• Resolved: 03/May/24 18:49

Description

Today, Ratis sometimes logs entire LogEntry messages with StateMachine data, for example:

@Override
public CompletableFuture<AppendEntriesReplyProto> appendEntriesAsync(
    ReferenceCountedObject<AppendEntriesRequestProto> requestRef) throws IOException {
  .....
  } catch(Exception t) {
    LOG.error("{}: Failed appendEntries* {}", getMemberId(), toAppendEntriesRequestString(r), t);
   ....
   } 
} 

This makes the logs painful to read for large StateMachine data scenarios. Specifically, in Ozone, StateMachine data is usually 4mb, and we see 4M-letters log lines which are very hard to navigate around. 

We should either filter StateMachine data when logging or restrict the log message to a certain limit. 

Issue Links

• links to: GitHub Pull Request #1074