Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimize GJULE log record source autodetection #25038

Merged
merged 2 commits into from
Jul 12, 2024
Merged

Optimize GJULE log record source autodetection #25038

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01f692e
Optimize log record source autodetection
avpinchuk Jul 10, 2024
49552bf
On-demand source autodetection initialization
avpinchuk Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 48 additions & 44 deletions ...assfish-jul-extension/src/main/java/org/glassfish/main/jul/record/GlassFishLogRecord.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -44,12 +45,13 @@ public class GlassFishLogRecord extends LogRecord {


/**
* 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);
Expand All @@ -59,21 +61,21 @@ 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);
this.threadName = Thread.currentThread().getName();
this.record = record;
if (autodetectSource) {
detectClassAndMethod(record);
SourceDetector.detectClassAndMethod(record);
}
}


/**
* @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;
Expand All @@ -84,7 +86,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;
Expand Down Expand Up @@ -266,7 +268,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) {
Expand All @@ -287,41 +289,43 @@ public String toString() {
return getMessage();
}

private static class SourceDetector {

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;
}
}
}


/**
* @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)
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".equals(sourceClassName)
"com.sun.logging.LogDomainsLogger",
// remaining classes are in the JDK
|| "java.util.logging.Logger".equals(sourceClassName)
|| "java.util.logging.LoggingProxyImpl".equals(sourceClassName)
"java.util.logging.Logger",
"java.util.logging.LoggingProxyImpl",
// see LoggingPrintStream
|| "java.lang.Throwable".equals(sourceClassName)
|| sourceClassName.startsWith("java.lang.reflect.")
|| sourceClassName.startsWith("sun.util.logging.")
|| sourceClassName.startsWith("sun.reflect.");
"java.lang.Throwable"
);

private static final StackWalker STACK_WALKER = StackWalker.getInstance(StackWalker.Option.SHOW_REFLECT_FRAMES);

static void detectClassAndMethod(final LogRecord wrappedRecord) {
STACK_WALKER
.walk(stackFrames ->
stackFrames.dropWhile(frame -> !isIgnoredStackFrame(frame.getClassName()))
dmatej marked this conversation as resolved.
Show resolved Hide resolved
.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.
*/
private static boolean isIgnoredStackFrame(final String sourceClassName) {
return IGNORED_CLASSES.contains(sourceClassName)
|| sourceClassName.startsWith("java.lang.reflect.")
|| sourceClassName.startsWith("sun.util.logging.")
|| sourceClassName.startsWith("sun.reflect.");
}
}
}