HADOOP-18958. Improve UserGroupInformation debug log. (#6255)

Contributed by zhihui wang
apache · May 14, 2024 · 39dee8e · 39dee8e
1 parent bda7045
commit 39dee8e
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 8 deletions.
diff --git a/...-project/hadoop-common/src/main/java/org/apache/hadoop/security/UserGroupInformation.java b/...-project/hadoop-common/src/main/java/org/apache/hadoop/security/UserGroupInformation.java
@@ -88,6 +88,7 @@
 import org.apache.hadoop.security.token.Token;
 import org.apache.hadoop.security.token.TokenIdentifier;
 import org.apache.hadoop.util.Shell;
+import org.apache.hadoop.util.StringUtils;
 import org.apache.hadoop.util.Time;
 
 import org.slf4j.Logger;
@@ -1934,10 +1935,7 @@ protected Subject getSubject() {
   @InterfaceAudience.Public
   @InterfaceStability.Evolving
   public <T> T doAs(PrivilegedAction<T> action) {
-    if (LOG.isDebugEnabled()) {
-      LOG.debug("PrivilegedAction [as: {}][action: {}]", this, action,
-          new Exception());
-    }
+    tracePrivilegedAction(action);
     return Subject.doAs(subject, action);
   }
 
@@ -1957,10 +1955,7 @@ public <T> T doAs(PrivilegedAction<T> action) {
   public <T> T doAs(PrivilegedExceptionAction<T> action
                     ) throws IOException, InterruptedException {
     try {
-      if (LOG.isDebugEnabled()) {
-        LOG.debug("PrivilegedAction [as: {}][action: {}]", this, action,
-            new Exception());
-      }
+      tracePrivilegedAction(action);
       return Subject.doAs(subject, action);
     } catch (PrivilegedActionException pae) {
       Throwable cause = pae.getCause();
@@ -1982,6 +1977,14 @@ public <T> T doAs(PrivilegedExceptionAction<T> action
     }
   }
 
+  private void tracePrivilegedAction(Object action) {
+    if (LOG.isTraceEnabled()) {
+      // would be nice if action included a descriptive toString()
+      LOG.trace("PrivilegedAction [as: {}][action: {}][from: {}]", this, action,
+          StringUtils.getStackTrace(new Throwable()));
+    }
+  }
+
   /**
    * Log current UGI and token information into specified log.
    * @param ugi - UGI

diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/StringUtils.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/StringUtils.java
@@ -1148,6 +1148,19 @@ public static String getStackTrace(Thread t) {
     return str.toString();
   }
 
+  /**
+   * Get stack trace from throwable exception.
+   * @param t Throwable.
+   * @return stack trace string.
+   */
+  public static String getStackTrace(Throwable t) {
+    StringBuilder str = new StringBuilder();
+    for (StackTraceElement e : t.getStackTrace()) {
+      str.append(e.toString() + "\n\t");
+    }
+    return str.toString();
+  }
+
   /**
    * From a list of command-line arguments, remove both an option and the 
    * next argument.

diff --git a/...op-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestStringUtils.java b/...op-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestStringUtils.java
@@ -624,6 +624,15 @@ public void testStringCollectionSplitByEqualsFailure() throws Exception {
         () -> StringUtils.getTrimmedStringCollectionSplitByEquals(",="));
   }
 
+  @Test
+  public void testForGetStackTrace() {
+    Throwable throwable = new Throwable();
+    int stackLength = throwable.getStackTrace().length;
+    String stackTrace = StringUtils.getStackTrace(new Throwable());
+    String[] splitTrace = stackTrace.split("\n\t");
+    assertEquals(stackLength, splitTrace.length);
+  }
+
   // Benchmark for StringUtils split
   public static void main(String []args) {
     final String TO_SPLIT = "foo,bar,baz,blah,blah";