Skip to content

Commit

Permalink
Issue #4567 - StdErrLog cleanup and final Arg Throwable support
Browse files Browse the repository at this point in the history 
Checkstyle fixes ...
+ Log.__loggers now Log.LOGGERS
+ Log.__props now Log.PROPS
+ StdErrLog.__tagpad now StdErrLog.THREADNAME_PADDING
+ StdErrLog.__source now StdErrLog.SOURCE
+ StdErrLog.__long now StdErrLog.LONG_CLASSNAMES
+ StdErrLog.__escape now StdErrLog.ESCAPE_CONTROL_CHARS
+ Removed redundant "public" modifier on Log interface methods

New code ...
+ New Log.getProperty(String key, String defaultValue)
  Used by JavaUtilLog, JettyLogHandler, and StdErrLog
+ New StdErrLog.getConfiguredLevel()
+ New StrErrLog.println(String) used to write StringBuilder
  to configured PrintStream

Removed code ...
+ Removed deprecated prop check in StdErrLog initialization

Cleanup and Corrected code ...
+ StdErrLog.setDebugEnabled(boolean) cleanup
+ StdErrLog._stderr is now used and is never null
+ Only one StdErrLog.format() method entry point
+ StdErrLog.format(StringBuilder, Throwable) now called .formatCause(StringBuilder, Throwable, String)

Signed-off-by: Joakim Erdfelt <[email protected]>
  • Loading branch information
@joakime
joakime committed Feb 13, 2020
1 parent 3c9c506 commit 3f3eaf2
Show file tree
Hide file tree
Showing 6 changed files with 193 additions and 170 deletions.
8 changes: 4 additions & 4 deletions jetty-util/src/main/java/org/eclipse/jetty/util/log/JavaUtilLog.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ public class JavaUtilLog extends AbstractLogger
{
private static final String THIS_CLASS = JavaUtilLog.class.getName();
private static final boolean __source =
Boolean.parseBoolean(Log.__props.getProperty("org.eclipse.jetty.util.log.SOURCE",
Log.__props.getProperty("org.eclipse.jetty.util.log.javautil.SOURCE", "true")));
Boolean.parseBoolean(Log.getProperty("org.eclipse.jetty.util.log.SOURCE",
Log.getProperty("org.eclipse.jetty.util.log.javautil.SOURCE", "true")));

private static boolean _initialized = false;

Expand All @@ -86,7 +86,7 @@ public JavaUtilLog(String name)
{
_initialized = true;

final String properties = Log.__props.getProperty("org.eclipse.jetty.util.log.javautil.PROPERTIES", null);
final String properties = Log.getProperty("org.eclipse.jetty.util.log.javautil.PROPERTIES", null);
if (properties != null)
{
AccessController.doPrivileged(new PrivilegedAction<Object>()
Expand Down Expand Up @@ -115,7 +115,7 @@ public Object run()

_logger = java.util.logging.Logger.getLogger(name);

switch (lookupLoggingLevel(Log.__props, name))
switch (lookupLoggingLevel(Log.getProperties(), name))
{
case LEVEL_ALL:
_logger.setLevel(Level.ALL);
Expand Down
4 changes: 2 additions & 2 deletions jetty-util/src/main/java/org/eclipse/jetty/util/log/JettyLogHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ public static void config()

public JettyLogHandler()
{
if (Boolean.parseBoolean(Log.__props.getProperty("org.eclipse.jetty.util.log.DEBUG", "false")))
if (Boolean.parseBoolean(Log.getProperty("org.eclipse.jetty.util.log.DEBUG", "false")))
{
setLevel(Level.FINEST);
}

if (Boolean.parseBoolean(Log.__props.getProperty("org.eclipse.jetty.util.log.IGNORED", "false")))
if (Boolean.parseBoolean(Log.getProperty("org.eclipse.jetty.util.log.IGNORED", "false")))
{
setLevel(Level.ALL);
}
Expand Down
29 changes: 17 additions & 12 deletions jetty-util/src/main/java/org/eclipse/jetty/util/log/Log.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ public class Log
/**
* Logging Configuration Properties
*/
protected static final Properties __props = new Properties();
private static final ConcurrentMap<String, Logger> __loggers = new ConcurrentHashMap<>();
protected static final Properties PROPS = new Properties();
private static final ConcurrentMap<String, Logger> LOGGERS = new ConcurrentHashMap<>();
private static boolean __initialized;
private static Logger LOG;

Expand All @@ -83,7 +83,7 @@ public Object run()
// * This is an optional feature used by embedded mode use, and test cases to allow for early
// * configuration of the Log class in situations where access to the System.properties are
// * either too late or just impossible.
loadProperties("jetty-logging.properties", __props);
loadProperties("jetty-logging.properties", PROPS);

// Next see if an OS specific jetty-logging.properties object exists in the classpath.
// This really for setting up test specific logging behavior based on OS.
Expand All @@ -92,7 +92,7 @@ public Object run()
{
// NOTE: cannot use jetty-util's StringUtil.replace() as it may initialize logging itself.
osName = osName.toLowerCase(Locale.ENGLISH).replace(' ', '-');
loadProperties("jetty-logging-" + osName + ".properties", __props);
loadProperties("jetty-logging-" + osName + ".properties", PROPS);
}

// Now load the System.properties as-is into the __props,
Expand All @@ -105,12 +105,12 @@ public Object run()
String val = System.getProperty(key);
// Protect against application code insertion of non-String values (returned as null).
if (val != null)
__props.setProperty(key, val);
PROPS.setProperty(key, val);
}

// Now use the configuration properties to configure the Log statics.
__logClass = __props.getProperty("org.eclipse.jetty.util.log.class", "org.eclipse.jetty.util.log.Slf4jLog");
__ignored = Boolean.parseBoolean(__props.getProperty("org.eclipse.jetty.util.log.IGNORED", "false"));
__logClass = PROPS.getProperty("org.eclipse.jetty.util.log.class", "org.eclipse.jetty.util.log.Slf4jLog");
__ignored = Boolean.parseBoolean(PROPS.getProperty("org.eclipse.jetty.util.log.IGNORED", "false"));
return null;
}
});
Expand Down Expand Up @@ -148,7 +148,7 @@ public static void initialized()
return;
__initialized = true;

boolean announce = Boolean.parseBoolean(__props.getProperty("org.eclipse.jetty.util.log.announce", "true"));
boolean announce = Boolean.parseBoolean(PROPS.getProperty("org.eclipse.jetty.util.log.announce", "true"));
try
{
Class<?> logClass = Loader.loadClass(Log.class, __logClass);
Expand Down Expand Up @@ -278,7 +278,7 @@ public static Logger getLogger(String name)
if (name == null)
return LOG;

Logger logger = __loggers.get(name);
Logger logger = LOGGERS.get(name);
if (logger == null)
logger = LOG.getLogger(name);

Expand All @@ -287,7 +287,7 @@ public static Logger getLogger(String name)

static ConcurrentMap<String, Logger> getMutableLoggers()
{
return __loggers;
return LOGGERS;
}

/**
Expand All @@ -298,11 +298,16 @@ static ConcurrentMap<String, Logger> getMutableLoggers()
@ManagedAttribute("list of all instantiated loggers")
public static Map<String, Logger> getLoggers()
{
return Collections.unmodifiableMap(__loggers);
return Collections.unmodifiableMap(LOGGERS);
}

public static Properties getProperties()
{
return __props;
return PROPS;
}

public static String getProperty(String key, String defaultValue)
{
return PROPS.getProperty(key, defaultValue);
}
}
30 changes: 15 additions & 15 deletions jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,73 +26,73 @@ public interface Logger
/**
* @return the name of this logger
*/
public String getName();
String getName();

/**
* Formats and logs at warn level.
*
* @param msg the formatting string
* @param args the optional arguments
*/
public void warn(String msg, Object... args);
void warn(String msg, Object... args);

/**
* Logs the given Throwable information at warn level
*
* @param thrown the Throwable to log
*/
public void warn(Throwable thrown);
void warn(Throwable thrown);

/**
* Logs the given message at warn level, with Throwable information.
*
* @param msg the message to log
* @param thrown the Throwable to log
*/
public void warn(String msg, Throwable thrown);
void warn(String msg, Throwable thrown);

/**
* Formats and logs at info level.
*
* @param msg the formatting string
* @param args the optional arguments
*/
public void info(String msg, Object... args);
void info(String msg, Object... args);

/**
* Logs the given Throwable information at info level
*
* @param thrown the Throwable to log
*/
public void info(Throwable thrown);
void info(Throwable thrown);

/**
* Logs the given message at info level, with Throwable information.
*
* @param msg the message to log
* @param thrown the Throwable to log
*/
public void info(String msg, Throwable thrown);
void info(String msg, Throwable thrown);

/**
* @return whether the debug level is enabled
*/
public boolean isDebugEnabled();
boolean isDebugEnabled();

/**
* Mutator used to turn debug on programmatically.
*
* @param enabled whether to enable the debug level
*/
public void setDebugEnabled(boolean enabled);
void setDebugEnabled(boolean enabled);

/**
* Formats and logs at debug level.
*
* @param msg the formatting string
* @param args the optional arguments
*/
public void debug(String msg, Object... args);
void debug(String msg, Object... args);

/**
* Formats and logs at debug level.
Expand All @@ -101,34 +101,34 @@ public interface Logger
* @param msg the formatting string
* @param value long value
*/
public void debug(String msg, long value);
void debug(String msg, long value);

/**
* Logs the given Throwable information at debug level
*
* @param thrown the Throwable to log
*/
public void debug(Throwable thrown);
void debug(Throwable thrown);

/**
* Logs the given message at debug level, with Throwable information.
*
* @param msg the message to log
* @param thrown the Throwable to log
*/
public void debug(String msg, Throwable thrown);
void debug(String msg, Throwable thrown);

/**
* @param name the name of the logger
* @return a logger with the given name
*/
public Logger getLogger(String name);
Logger getLogger(String name);

/**
* Ignore an exception.
* <p>This should be used rather than an empty catch block.
*
* @param ignored the throwable to log as ignored
*/
public void ignore(Throwable ignored);
void ignore(Throwable ignored);
}
Loading

0 comments on commit 3f3eaf2

Please sign in to comment.