Optimize log record source autodetection

Signed-off-by: Alexander Pinčuk <[email protected]>
eclipse-ee4j · Jul 11, 2024 · 01f692e · 01f692e
1 parent a3faa17
commit 01f692e
Showing 1 changed file with 38 additions and 35 deletions.
diff --git a/...assfish-jul-extension/src/main/java/org/glassfish/main/jul/record/GlassFishLogRecord.java b/...assfish-jul-extension/src/main/java/org/glassfish/main/jul/record/GlassFishLogRecord.java
@@ -23,12 +23,13 @@
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
 import java.util.ResourceBundle;
+import java.util.Set;
 import java.util.logging.ErrorManager;
 import java.util.logging.Level;
 import java.util.logging.LogRecord;
 
 /**
- * This class provides additional attributes not supported by JUL LogRecord
+ * This class provides additional attributes not supported by JUL LogRecord.
  *
  * @author David Matejcek
  */
@@ -38,18 +39,33 @@ public class GlassFishLogRecord extends LogRecord {
 
     private static final ZoneId TIME_ZONE = ZoneId.systemDefault();
 
+    private static final StackWalker STACK_WALKER = StackWalker.getInstance(StackWalker.Option.SHOW_REFLECT_FRAMES);
+
+    private static final Set<String> IGNORED_CLASSES = Set.of(
+        "org.glassfish.main.jul.GlassFishLogger",
+        "org.glassfish.main.jul.GlassFishLoggerWrapper",
+        // see LogDomains in GlassFish sources
+        "com.sun.logging.LogDomainsLogger",
+        // remaining classes are in the JDK
+        "java.util.logging.Logger",
+        "java.util.logging.LoggingProxyImpl",
+        // see LoggingPrintStream
+        "java.lang.Throwable"
+    );
+
     private final LogRecord record;
     private final String threadName;
     private String messageKey;
 
 
     /**
-     * Creates new record. Source class and method will be autodetected now or set after this
-     * constructor ends.
+     * Creates new record.
+     * <p>
+     * Source class and method will be autodetected now or set after this constructor ends.
      *
-     * @param level
-     * @param message
-     * @param autodetectSource
+     * @param level a logging level value
+     * @param message the logging message
+     * @param autodetectSource autodetect source class and method
      */
     public GlassFishLogRecord(final Level level, final String message, final boolean autodetectSource) {
         this(new LogRecord(level, message), autodetectSource);
@@ -59,8 +75,8 @@ public GlassFishLogRecord(final Level level, final String message, final boolean
     /**
      * Wraps the log record.
      *
-     * @param record
-     * @param autodetectSource
+     * @param record the log record
+     * @param autodetectSource autodetect source class and method
      */
     public GlassFishLogRecord(final LogRecord record, final boolean autodetectSource) {
         super(record.getLevel(), null);
@@ -73,7 +89,7 @@ public GlassFishLogRecord(final LogRecord record, final boolean autodetectSource
 
 
     /**
-     * @return the message identifier (generally not unique, may be null)
+     * @return the message identifier (generally not unique, may be {@code null})
      */
     public String getMessageKey() {
         return messageKey;
@@ -84,7 +100,7 @@ public String getMessageKey() {
      * This is called just to remember the original message value after it was translated using
      * the resource bundle.
      *
-     * @param messageKey the message identifier (generally not unique, may be null)
+     * @param messageKey the message identifier (generally not unique, may be {@code null})
      */
     void setMessageKey(final String messageKey) {
         this.messageKey = messageKey;
@@ -266,7 +282,7 @@ public OffsetDateTime getTime() {
 
 
     /**
-     * @return printed stacktrace of {@link #getThrown()} or null
+     * @return printed stacktrace of {@link #getThrown()} or {@code null}
      */
     public String getThrownStackTrace() {
         if (getThrown() == null) {
@@ -289,37 +305,24 @@ public String toString() {
 
 
     private void detectClassAndMethod(final LogRecord wrappedRecord) {
-        final StackTraceElement[] stack = Thread.currentThread().getStackTrace();
-        boolean ignoredClass = false;
-        for (final StackTraceElement element : stack) {
-            final String className = element.getClassName();
-            if (!ignoredClass) {
-                ignoredClass = isIgnoredStackTraceElement(className);
-                continue;
-            }
-            if (!isIgnoredStackTraceElement(className)) {
-                wrappedRecord.setSourceClassName(className);
-                wrappedRecord.setSourceMethodName(element.getMethodName());
-                return;
-            }
-        }
+        STACK_WALKER
+            .walk(stackFrames ->
+                stackFrames.dropWhile(frame -> !isIgnoredStackFrame(frame.getClassName()))
+                    .filter(frame -> !isIgnoredStackFrame(frame.getClassName()))
+                    .findFirst())
+            .ifPresent(frame -> {
+                wrappedRecord.setSourceClassName(frame.getClassName());
+                wrappedRecord.setSourceMethodName(frame.getMethodName());
+            });
     }
 
 
     /**
      * @param sourceClassName usually class which created this record
      * @return if true the class will not be used as a source.
      */
-    protected boolean isIgnoredStackTraceElement(final String sourceClassName) {
-        return "org.glassfish.main.jul.GlassFishLogger".equals(sourceClassName)
-            || "org.glassfish.main.jul.GlassFishLoggerWrapper".equals(sourceClassName)
-            // see LogDomains in GlassFish sources
-            || "com.sun.logging.LogDomainsLogger".equals(sourceClassName)
-            // remaining classes are in the JDK
-            || "java.util.logging.Logger".equals(sourceClassName)
-            || "java.util.logging.LoggingProxyImpl".equals(sourceClassName)
-            // see LoggingPrintStream
-            || "java.lang.Throwable".equals(sourceClassName)
+    protected boolean isIgnoredStackFrame(final String sourceClassName) {
+        return IGNORED_CLASSES.contains(sourceClassName)
             || sourceClassName.startsWith("java.lang.reflect.")
             || sourceClassName.startsWith("sun.util.logging.")
             || sourceClassName.startsWith("sun.reflect.");