[HDFS-16648] Normalize the usage of debug logs in NameNode

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.4.0
• Fix Version/s: 3.4.0
• Component/s: namenode
• Labels: pull-request-available
• Target Version/s: 3.4.0
• Assignee: ZanderXu
• Reporter: ZanderXu
• Created: 01/Jul/22 11:45
• Updated: 16/Oct/24 18:29
• Resolved: 06/Aug/22 13:35

Description

There are many irregular debug logs in NameNode. such as:
Error type1:

if (LOG.isDebugEnabled()) {
      LOG.debug("Getting groups for user " + user);
}

we can format it to:

LOG.debug("Getting groups for user {}. ", user);

Error type2:

LOG.debug("*DIR* NameNode.renameSnapshot: Snapshot Path {}, " +
        "snapshotOldName {}, snapshotNewName {}", snapshotRoot,
        snapshotOldName, snapshotNewName);

we can format it to:

if (LOG.isDebugEnabled()) {
  LOG.debug("*DIR* NameNode.renameSnapshot: Snapshot Path {}, " +
        "snapshotOldName {}, snapshotNewName {}", snapshotRoot,
        snapshotOldName, snapshotNewName); 
}

Error type3:

if (LOG.isDebugEnabled()) {
      LOG.debug("getAdditionalDatanode: src=" + src
          + ", fileId=" + fileId
          + ", blk=" + blk
          + ", existings=" + Arrays.asList(existings)
          + ", excludes=" + Arrays.asList(excludes)
          + ", numAdditionalNodes=" + numAdditionalNodes
          + ", clientName=" + clientName);
    }

We can format it to:

 if (LOG.isDebugEnabled()) {
   LOG.debug("getAdditionalDatanode: src={}, fileId={}, "
           + "blk={}, existings={}, excludes={}, numAdditionalNodes={}, "
          + "clientName={}.", src, fileId, blk, Arrays.asList(existings),
          Arrays.asList(excludes), numAdditionalNodes, clientName);
 }

Issue Links

• links to: GitHub Pull Request #4529