Class AbstractStatistic

java.lang.Object

java.lang.Thread

clazzfish.core.util.ShutdownHook

clazzfish.monitor.AbstractMonitor

clazzfish.jdbc.AbstractStatistic

All Implemented Interfaces:

Shutdownable, AbstractStatisticMBean, AbstractMonitorMBean, Runnable

Direct Known Subclasses:

SqlStatistic

public abstract class AbstractStatistic
extends AbstractMonitor
implements AbstractStatisticMBean

This was constructed as a thin layer around com.jamonapi.MonitorFactory for the needs of generating statistics. The reason for this layer is that sometimes you want to minimize the use of other libraries. So this implementation provides also an implementation if the JaMon library is missing.

Since:

0.9

Author:

oliver

Nested Class Summary

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStatistic(String rootLabel)	Instantiates a new profile statistic.

Method Summary

Modifier and Type	Method	Description
File	dumpMe()	This operation dumps statistic into a (temporary) file with the classname as prefix.
void	dumpMe(File dumpFile)	Dump statistic to the given file.
protected List<String>	getCsvLines()
double	getMaxAvg()	Gets the max avg.
String	getMaxAvgLabel()	Gets the max avg label.
String	getMaxAvgStatistic()	Gets the max avg statistic.
int	getMaxHits()	Gets the max hits.
String	getMaxHitsLabel()	Gets the max hits label.
String	getMaxHitsStatistic()	Gets the max hits statistic.
double	getMaxMax()	Gets the max max.
String	getMaxMaxLabel()	Gets the max max label.
String	getMaxMaxStatistic()	Gets the max max statistic.
int	getMaxSize()	Gets the max size.
double	getMaxTotal()	Gets the max total.
String	getMaxTotalLabel()	Gets the max total label.
String	getMaxTotalStatistic()	Gets the max total statistic.
ProfileMonitor	getMonitor(String label)	Returns the monitor for the given label.
ProfileMonitor[]	getMonitors()	Gets the monitors (unsorted).
protected final ProfileMonitor[]	getSortedMonitors()	Gets the sorted monitors.
TabularData	getStatistics()	Gets the statistics.
void	logMe()	Log statistic.
void	reset()	We can't reset all ProfileMonitors - we must keep the empty monitors with 0 hits to see which methods or constructors are never called.
protected void	resetRootMonitor()	Resets the root monitor.
void	setMaxSize(int size)	Here you can set the maximal size of the statistic entries.
ProfileMonitor	startProfileMonitorFor(String sig)	Start profile monitor for the given signature.

Methods inherited from class AbstractMonitor

copyResource, dump, dump, dumpArray, dumpArray, dumpHeadline, dumpMe, exportCSV, getDumpDir, isMBean, registerMeAsMBean, registerMeAsMBean, run, toString, toStringArray, unregisterMeAsMBean

Modifier and Type	Method	Description
protected void	copyResource(String name, File file)	Copy a resource to the given file.
protected void	dump(BufferedWriter writer, String... getterMethodNames)	This operation dumps the different MBean attributes.
protected void	dump(File dumpDir, String... getterMethodNames)	Dumps different arrays to the given dumpDir directory, each array in its own file.
protected static void	dumpArray(Object[] array, BufferedWriter writer, String title)	Dump array.
protected static void	dumpArray(Object[] array, File dir, String title)	Dumps an array to the given directory.
protected static void	dumpHeadline(BufferedWriter writer, String headline)	Dump headline.
void	dumpMe(String dirname)	This operation dumps the different MBean attributes to the given directory.
URI	exportCSV()	If you want to configure via Config.DUMP_URI the location where the monitored data should be exported you should override this method.
File	getDumpDir()	The base directory where all is dumped can be configured (see Config.getDumpDir().
boolean	isMBean()	If you want to ask JMX if bean is already registered you can ask the MBeanHelper or you can ask this method.
void	registerMeAsMBean()	With this method you can register the monitor with the default name.
void	registerMeAsMBean(ObjectName name)	With this method you can register the monitor with your own name.
void	run()	This method is called when the ClasspathMonitor is registered as shutdown hook.
String	toString()	As the toString implementation the name of the registered MBean is used.
protected static String[]	toStringArray(URI[] uris)	We remove the URI prefix from the result to be in-line with the other classpath methods.
void	unregisterMeAsMBean()	Unregister monitor as MBean.

Methods inherited from class ShutdownHook

addMeAsShutdownHook, isShutdownHook, removeMeAsShutdownHook

Modifier and Type	Method	Description
void	addMeAsShutdownHook()	To be able to register the class as shutdown hook via JMX we can't use a static method - this is the reason why this additional method was added.
boolean	isShutdownHook()	Here you can ask if the class was already registered as shutdown hook.
void	removeMeAsShutdownHook()	If you want to unregister the instance as shutdown hook you can use this (not static) method.

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, threadId, yield

Methods inherited from class Object

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

Constructor Details

AbstractStatistic

protected AbstractStatistic(String rootLabel)

Instantiates a new profile statistic.

Parameters:

rootLabel - the root label

Method Details

reset

public void reset()

We can't reset all ProfileMonitors - we must keep the empty monitors with 0 hits to see which methods or constructors are never called.

Specified by:

reset in interface AbstractStatisticMBean

resetRootMonitor

protected void resetRootMonitor()

Resets the root monitor.

setMaxSize

public void setMaxSize(int size)

Here you can set the maximal size of the statistic entries.

Specified by:

setMaxSize in interface AbstractStatisticMBean

Parameters:

size - the new max size

getMaxSize

public int getMaxSize()

Gets the max size.

Specified by:

getMaxSize in interface AbstractStatisticMBean

Returns:

the max size

startProfileMonitorFor

public ProfileMonitor startProfileMonitorFor(String sig)

Start profile monitor for the given signature.

Parameters:

sig - the signature

Returns:

the profile monitor

getMonitors

public ProfileMonitor[] getMonitors()

Gets the monitors (unsorted).

Returns:

the monitors

getMonitor

public ProfileMonitor getMonitor(String label)

Returns the monitor for the given label. It it does not exists an IllegalArgumentException will be thrown.

Parameters:

label - label of the monitor

Returns:

monitor with the given label

getSortedMonitors

protected final ProfileMonitor[] getSortedMonitors()

Gets the sorted monitors.

Returns:

monitors sorted after total time (descending order)

getMaxHits

public int getMaxHits()

Gets the max hits.

Specified by:

getMaxHits in interface AbstractStatisticMBean

Returns:

the max hits

getMaxHitsLabel

public String getMaxHitsLabel()

Gets the max hits label.

Specified by:

getMaxHitsLabel in interface AbstractStatisticMBean

Returns:

the max hits label

getMaxHitsStatistic

public String getMaxHitsStatistic()

Gets the max hits statistic.

Specified by:

getMaxHitsStatistic in interface AbstractStatisticMBean

Returns:

the max hits statistic

getMaxTotal

public double getMaxTotal()

Gets the max total.

Specified by:

getMaxTotal in interface AbstractStatisticMBean

Returns:

the max total

getMaxTotalLabel

public String getMaxTotalLabel()

Gets the max total label.

Specified by:

getMaxTotalLabel in interface AbstractStatisticMBean

Returns:

the max total label

getMaxTotalStatistic

public String getMaxTotalStatistic()

Gets the max total statistic.

Specified by:

getMaxTotalStatistic in interface AbstractStatisticMBean

Returns:

the max total statistic

getMaxAvg

public double getMaxAvg()

Gets the max avg.

Specified by:

getMaxAvg in interface AbstractStatisticMBean

Returns:

the max avg

getMaxAvgLabel

public String getMaxAvgLabel()

Gets the max avg label.

Specified by:

getMaxAvgLabel in interface AbstractStatisticMBean

Returns:

the max avg label

getMaxAvgStatistic

public String getMaxAvgStatistic()

Gets the max avg statistic.

Specified by:

getMaxAvgStatistic in interface AbstractStatisticMBean

Returns:

the max avg statistic

getMaxMax

public double getMaxMax()

Gets the max max.

Specified by:

getMaxMax in interface AbstractStatisticMBean

Returns:

the max max

getMaxMaxLabel

public String getMaxMaxLabel()

Gets the max max label.

Specified by:

getMaxMaxLabel in interface AbstractStatisticMBean

Returns:

the max max label

getMaxMaxStatistic

public String getMaxMaxStatistic()

Gets the max max statistic.

Specified by:

getMaxMaxStatistic in interface AbstractStatisticMBean

Returns:

the max max statistic

getStatistics

public TabularData getStatistics()

Gets the statistics.

Specified by:

getStatistics in interface AbstractStatisticMBean

Returns:

the statistics

logMe

public void logMe()

Log statistic.

Specified by:

logMe in interface AbstractMonitorMBean

Specified by:

logMe in class AbstractMonitor

dumpMe

public File dumpMe()
            throws IOException

This operation dumps statistic into a (temporary) file with the classname as prefix. The name of the created file is returned so that you can see it in the 'jconsole' (if you have triggered it from there).

Specified by:

dumpMe in interface AbstractMonitorMBean

Overrides:

dumpMe in class AbstractMonitor

Returns:

the file

Throws:

IOException - Signals that an I/O exception has occurred.

See Also:

• AbstractMonitorMBean.dumpMe()

dumpMe

public void dumpMe(File dumpFile)
            throws IOException

Dump statistic to the given file.

Overrides:

dumpMe in class AbstractMonitor

Parameters:

dumpFile - the dump file

Throws:

IOException - Signals that an I/O exception has occurred.

getCsvLines

protected List<String> getCsvLines()