org.das2.util

Class LoggerManager

java.lang.Object

org.das2.util.LoggerManager

public final class LoggerManager
extends java.lang.Object

Central place that keeps track of loggers. Note that both org.das.datum and org.das2.datum have this same class, which is there to avoid coupling between the packages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggerManager.TimeTaggingLogger Logger keeps track of the last record timetag.

Constructor Summary

Constructors

Constructor and Description
LoggerManager()

Method Summary

Modifier and Type	Method and Description
static void	addHandlerToAll(java.util.logging.Handler handler) Add the handler to all loggers created by this manager, and all future.
static void	clearTimer() explicitly remove this timer.
static java.util.logging.Logger	getLogger(java.lang.String id) return the requested logger, but add it to the list of known loggers.
static java.util.Set<java.lang.String>	getLoggers() return the list of known loggers.
static boolean	isEnableTimers() return enableTimers property.
static boolean	isUseTimeTaggingLoggers() are we keeping track of log message times, so we can sort loggers by how recently messages were posted?
static void	logExitGuiEvent(java.awt.event.ActionEvent e) call this at the end of the GUI event to measure time to respond.
static void	logExitGuiEvent(javax.swing.event.ChangeEvent e) call this at the end of the GUI event to measure time to respond.
static void	logExitGuiEvent(java.awt.event.FocusEvent e) call this at the end of the GUI event to measure time to respond.
static void	logExitGuiEvent(java.awt.event.ItemEvent e) call this at the end of the GUI event to measure time to respond.
static void	logGuiEvent(java.awt.event.ActionEvent e) provide easy way to log all GUI events.
static void	logGuiEvent(javax.swing.event.ChangeEvent e) log the GUI ChangeEvent
static void	logGuiEvent(java.awt.event.FocusEvent e) log the GUI FocusEvent
static void	logGuiEvent(java.awt.event.ItemEvent e) log the GUI ItemEvent
static void	logPropertyChangeEvent(java.beans.PropertyChangeEvent e) log property change events.
static void	logPropertyChangeEvent(java.beans.PropertyChangeEvent e, java.lang.String source) log property change events.
static void	markTime() mark the time using the thread name.
static void	markTime(java.lang.String message) mark the time that this occurred.
static void	readConfiguration() A slightly more transparent logging configuration would provide feedback about what configuration file it's loading.
static void	readConfiguration(java.lang.String configfile) A slightly more transparent logging configuration would provide feedback about what configuration file it's loading.
static void	resetTimer() reset the timer.
static void	resetTimer(java.lang.String task) reset the timer for this thread.
static void	setEnableTimers(boolean enableTimers) if enableTimers is true, then resetTimer and markTime have an effect.
static void	setTimerLogfile(java.lang.String f) channel the logging information to here, setEnableTimers(false) to close.
static void	setUseTimeTaggingLoggers(boolean t)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggerManager

public LoggerManager()

Method Detail

setUseTimeTaggingLoggers

public static void setUseTimeTaggingLoggers(boolean t)

Parameters:

t -

isUseTimeTaggingLoggers

public static boolean isUseTimeTaggingLoggers()

are we keeping track of log message times, so we can sort loggers by how recently messages were posted?

Returns:

true if we are keeping track of log message times.

getLogger

public static java.util.logging.Logger getLogger(java.lang.String id)

return the requested logger, but add it to the list of known loggers.

Parameters:

id - the name

Returns:

the Logger

getLoggers

public static java.util.Set<java.lang.String> getLoggers()

return the list of known loggers.

Returns:

the list of known loggers.

addHandlerToAll

public static void addHandlerToAll(java.util.logging.Handler handler)

Add the handler to all loggers created by this manager, and all future. Only call this once! I would think that adding a handler to the root would essentially add the handler to all loggers, but it doesn't seem to.

Parameters:

handler - e.g. GraphicalLogHandler

isEnableTimers

public static boolean isEnableTimers()

return enableTimers property.

Returns:

enableTimers property.

setEnableTimers

public static void setEnableTimers(boolean enableTimers)

if enableTimers is true, then resetTimer and markTime have an effect. Each thread can have a timer to measure the execution time for a process.

Parameters:

enableTimers - true to enable timers

setTimerLogfile

public static void setTimerLogfile(java.lang.String f)
                            throws java.io.FileNotFoundException

channel the logging information to here, setEnableTimers(false) to close.

Parameters:

f -

Throws:

java.io.FileNotFoundException

resetTimer

public static void resetTimer()

reset the timer. The lifecycle is like so:

• LoggerManager.setTimerLogfile("/tmp/mylogfile.txt")
• LoggerManager.resetTimer("big task");
• LoggerManager.markTime("done loading");
• LoggerManager.markTime("calculated data");
• LoggerManager.clearTimer();

Note the timers are stored with weak references to the threads, so clearTimer needn't be called.

resetTimer

public static void resetTimer(java.lang.String task)

reset the timer for this thread. The lifecycle is like so:

• LoggerManager.setTimerLogfile("/tmp/mylogfile.txt")
• LoggerManager.resetTimer("big task");
• LoggerManager.markTime("done loading");
• LoggerManager.markTime("calculated data");
• LoggerManager.clearTimer();

Note the timers are stored with weak references to the threads, so clearTimer needn't be called.

Parameters:

task -

See Also:

setEnableTimers(boolean), setTimerLogfile(java.lang.String)

markTime

public static void markTime()

mark the time using the thread name.

markTime

public static void markTime(java.lang.String message)

mark the time that this occurred.

Parameters:

message - message to accompany

See Also:

to turn on timers., to reset timers.

clearTimer

public static void clearTimer()

explicitly remove this timer.

See Also:

resetTimer()

logGuiEvent

public static void logGuiEvent(java.awt.event.ActionEvent e)

provide easy way to log all GUI events.

Parameters:

e -

logExitGuiEvent

public static void logExitGuiEvent(java.awt.event.ActionEvent e)

call this at the end of the GUI event to measure time to respond.

Parameters:

e - the focus event.

logGuiEvent

public static void logGuiEvent(javax.swing.event.ChangeEvent e)

log the GUI ChangeEvent

Parameters:

e -

logExitGuiEvent

public static void logExitGuiEvent(javax.swing.event.ChangeEvent e)

call this at the end of the GUI event to measure time to respond.

Parameters:

e - the focus event.

logGuiEvent

public static void logGuiEvent(java.awt.event.ItemEvent e)

log the GUI ItemEvent

Parameters:

e -

logExitGuiEvent

public static void logExitGuiEvent(java.awt.event.ItemEvent e)

call this at the end of the GUI event to measure time to respond.

Parameters:

e - the focus event.

logGuiEvent

public static void logGuiEvent(java.awt.event.FocusEvent e)

log the GUI FocusEvent

Parameters:

e -

logExitGuiEvent

public static void logExitGuiEvent(java.awt.event.FocusEvent e)

call this at the end of the GUI event to measure time to respond.

Parameters:

e - the focus event.

logPropertyChangeEvent

public static void logPropertyChangeEvent(java.beans.PropertyChangeEvent e)

log property change events. (I realized I spend a lot of time debugging walking through the property change fire event code, and I should just add a log message to all propertyChange codes.)

Parameters:

e -

logPropertyChangeEvent

public static void logPropertyChangeEvent(java.beans.PropertyChangeEvent e,
                                          java.lang.String source)

log property change events. (I realized I spend a lot of time debugging walking through the property change fire event code, and I should just add a log message to all propertyChange codes.)

Parameters:

e -

source - comment on the source

readConfiguration

public static void readConfiguration()

A slightly more transparent logging configuration would provide feedback about what configuration file it's loading. This will echo when the configuration file would be. The idea is when you are completely frustrated with not getting the logger to behave, you can add: org.das2.util.LoggerManager.readConfiguration() to your code.

readConfiguration

public static void readConfiguration(java.lang.String configfile)

A slightly more transparent logging configuration would provide feedback about what configuration file it's loading. This will echo when the configuration file would be. The idea is when you are completely frustrated with not getting the logger to behave, you can add: org.das2.util.LoggerManager.readConfiguration() to your code.

Parameters:

configfile - the file to read