org.eclipse.jetty.util.log

Class StdErrLog

java.lang.Object

org.eclipse.jetty.util.log.AbstractLogger

org.eclipse.jetty.util.log.StdErrLog

All Implemented Interfaces:

Logger

@ManagedObject(value="Jetty StdErr Logging Implementation")
public class StdErrLog
extends AbstractLogger

StdErr Logging implementation.

A Jetty Logger that sends all logs to STDERR (System.err) with basic formatting.

Supports named loggers, and properties based configuration.

Configuration Properties:

${name|hierarchy}.LEVEL=(ALL|DEBUG|INFO|WARN|OFF)

Sets the level that the Logger should log at.
Names can be a package name, or a fully qualified class name.
Default: INFO

Examples:

org.eclipse.jetty.LEVEL=WARN

indicates that all of the jetty specific classes, in any package that starts with org.eclipse.jetty should log at level WARN.

org.eclipse.jetty.io.ChannelEndPoint.LEVEL=ALL

indicates that the specific class, ChannelEndPoint, should log all logging events that it can generate, including DEBUG, INFO, WARN (and even special internally ignored exception cases).

${name}.SOURCE=(true|false)

Logger specific, attempt to print the java source file name and line number where the logging event originated from.
Name must be a fully qualified class name (package name hierarchy is not supported by this configurable)
Warning: this is a slow operation and will have an impact on performance!
Default: false

${name}.STACKS=(true|false)

Logger specific, control the display of stacktraces.
Name must be a fully qualified class name (package name hierarchy is not supported by this configurable)
Default: true

org.eclipse.jetty.util.log.stderr.SOURCE=(true|false)

Special Global Configuration, attempt to print the java source file name and line number where the logging event originated from.
Default: false

org.eclipse.jetty.util.log.stderr.LONG=(true|false)

Special Global Configuration, when true, output logging events to STDERR using long form, fully qualified class names. when false, use abbreviated package names
Default: false

org.eclipse.jetty.util.log.stderr.ESCAPE=(true|false)

Global Configuration, when true output logging events to STDERR are always escaped so that control characters are replaced with '?"; '\r' with '<' and '\n' replaced '|'
Default: true

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEVEL_ALL
static int	LEVEL_DEBUG
static int	LEVEL_INFO
static int	LEVEL_OFF
static int	LEVEL_WARN

Constructor Summary

Constructors

Constructor and Description
StdErrLog() Construct an anonymous StdErrLog (no name).
StdErrLog(String name) Construct a named StdErrLog using the Log defined properties
StdErrLog(String name, Properties props) Construct a named Logger using the provided properties to configure logger.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	condensePackageString(String classname) Condenses a classname by stripping down the package name to just the first character of each package name segment.Configured
void	debug(String msg, long arg) Formats and logs at debug level.
void	debug(String msg, Object... args) Formats and logs at debug level.
void	debug(String msg, Throwable thrown) Logs the given message at debug level, with Throwable information.
void	debug(Throwable thrown) Logs the given Throwable information at debug level
int	getLevel()
protected static int	getLevelId(String levelSegment, String levelName)
static StdErrLog	getLogger(Class<?> clazz) Obtain a StdErrLog reference for the specified class, a convenience method used most often during testing to allow for control over a specific logger.
static int	getLoggingLevel(Properties props, String name) Get the Logging Level for the provided log name.
static String	getLoggingProperty(Properties props, String name, String property)
String	getName()
void	ignore(Throwable ignored) Ignore an exception.
void	info(String msg, Object... args) Formats and logs at info level.
void	info(String msg, Throwable thrown) Logs the given message at info level, with Throwable information.
void	info(Throwable thrown) Logs the given Throwable information at info level
boolean	isDebugEnabled()
boolean	isHideStacks()
boolean	isPrintLongNames()
boolean	isSource() Is the source of a log, logged
protected Logger	newLogger(String fullname) Create a Child Logger of this Logger.
void	setDebugEnabled(boolean enabled) Legacy interface where a programmatic configuration of the logger level is done as a wholesale approach.
void	setHideStacks(boolean hideStacks)
void	setLevel(int level) Set the level for this logger.
void	setPrintLongNames(boolean printLongNames)
static void	setProperties(Properties props)
void	setSource(boolean source) Set if a log source is logged.
void	setStdErrStream(PrintStream stream)
String	toString()
void	warn(String msg, Object... args) Formats and logs at warn level.
void	warn(String msg, Throwable thrown) Logs the given message at warn level, with Throwable information.
void	warn(Throwable thrown) Logs the given Throwable information at warn level

Methods inherited from class org.eclipse.jetty.util.log.AbstractLogger

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LEVEL_ALL

public static final int LEVEL_ALL

See Also:

Constant Field Values

LEVEL_DEBUG

public static final int LEVEL_DEBUG

See Also:

Constant Field Values

LEVEL_INFO

public static final int LEVEL_INFO

See Also:

Constant Field Values

LEVEL_WARN

public static final int LEVEL_WARN

See Also:

Constant Field Values

LEVEL_OFF

public static final int LEVEL_OFF

See Also:

Constant Field Values

Constructor Detail

StdErrLog

public StdErrLog()

Construct an anonymous StdErrLog (no name).

NOTE: Discouraged usage!

StdErrLog

public StdErrLog(String name)

Construct a named StdErrLog using the Log defined properties

Parameters:

name - the name of the logger

StdErrLog

public StdErrLog(String name,
         Properties props)

Construct a named Logger using the provided properties to configure logger.

Parameters:

name - the name of the logger

props - the configuration properties

Method Detail

getLogger

public static StdErrLog getLogger(Class<?> clazz)

Obtain a StdErrLog reference for the specified class, a convenience method used most often during testing to allow for control over a specific logger.

Must be actively using StdErrLog as the Logger implementation.

Parameters:

clazz - the Class reference for the logger to use.

Returns:

the StdErrLog logger

Throws:

RuntimeException - if StdErrLog is not the active Logger implementation.

getLoggingLevel

public static int getLoggingLevel(Properties props,
                  String name)

Get the Logging Level for the provided log name. Using the FQCN first, then each package segment from longest to shortest.

Parameters:

props - the properties to check

name - the name to get log for

Returns:

the logging level

getLoggingProperty

public static String getLoggingProperty(Properties props,
                        String name,
                        String property)

getLevelId

protected static int getLevelId(String levelSegment,
             String levelName)

condensePackageString

protected static String condensePackageString(String classname)

Condenses a classname by stripping down the package name to just the first character of each package name segment.Configured

 Examples:
 "org.eclipse.jetty.test.FooTest"           = "oejt.FooTest"
 "org.eclipse.jetty.server.logging.LogTest" = "orjsl.LogTest"
 

Parameters:

classname - the fully qualified class name

Returns:

the condensed name

getName

public String getName()

Returns:

the name of this logger

setPrintLongNames

public void setPrintLongNames(boolean printLongNames)

isPrintLongNames

public boolean isPrintLongNames()

isHideStacks

public boolean isHideStacks()

setHideStacks

public void setHideStacks(boolean hideStacks)

isSource

public boolean isSource()

Is the source of a log, logged

Returns:

true if the class, method, file and line number of a log is logged.

setSource

public void setSource(boolean source)

Set if a log source is logged.

Parameters:

source - true if the class, method, file and line number of a log is logged.

warn

public void warn(String msg,
        Object... args)

Description copied from interface: Logger

Formats and logs at warn level.

Parameters:

msg - the formatting string

args - the optional arguments

warn

public void warn(Throwable thrown)

Description copied from interface: Logger

Logs the given Throwable information at warn level

Parameters:

thrown - the Throwable to log

warn

public void warn(String msg,
        Throwable thrown)

Description copied from interface: Logger

Logs the given message at warn level, with Throwable information.

Parameters:

msg - the message to log

thrown - the Throwable to log

info

public void info(String msg,
        Object... args)

Description copied from interface: Logger

Formats and logs at info level.

Parameters:

msg - the formatting string

args - the optional arguments

info

public void info(Throwable thrown)

Description copied from interface: Logger

Logs the given Throwable information at info level

Parameters:

thrown - the Throwable to log

info

public void info(String msg,
        Throwable thrown)

Description copied from interface: Logger

Logs the given message at info level, with Throwable information.

Parameters:

msg - the message to log

thrown - the Throwable to log

isDebugEnabled

@ManagedAttribute(value="is debug enabled for root logger Log.LOG")
public boolean isDebugEnabled()

Returns:

whether the debug level is enabled

setDebugEnabled

public void setDebugEnabled(boolean enabled)

Legacy interface where a programmatic configuration of the logger level is done as a wholesale approach.

Parameters:

enabled - whether to enable the debug level

getLevel

public int getLevel()

setLevel

public void setLevel(int level)

Set the level for this logger.

Available values (LEVEL_ALL, LEVEL_DEBUG, LEVEL_INFO, LEVEL_WARN)

Parameters:

level - the level to set the logger to

setStdErrStream

public void setStdErrStream(PrintStream stream)

debug

public void debug(String msg,
         Object... args)

Description copied from interface: Logger

Formats and logs at debug level.

Parameters:

msg - the formatting string

args - the optional arguments

debug

public void debug(String msg,
         long arg)

Description copied from interface: Logger

Formats and logs at debug level. avoids autoboxing of integers

Specified by:

debug in interface Logger

Overrides:

debug in class AbstractLogger

Parameters:

msg - the formatting string

arg - long value

debug

public void debug(Throwable thrown)

Description copied from interface: Logger

Logs the given Throwable information at debug level

Parameters:

thrown - the Throwable to log

debug

public void debug(String msg,
         Throwable thrown)

Description copied from interface: Logger

Logs the given message at debug level, with Throwable information.

Parameters:

msg - the message to log

thrown - the Throwable to log

newLogger

protected Logger newLogger(String fullname)

Create a Child Logger of this Logger.

Specified by:

newLogger in class AbstractLogger

toString

public String toString()

Overrides:

toString in class Object

setProperties

public static void setProperties(Properties props)

ignore

public void ignore(Throwable ignored)

Description copied from interface: Logger

Ignore an exception.

This should be used rather than an empty catch block.