Class SqlStatistic

java.lang.Object

java.lang.Thread

clazzfish.core.util.ShutdownHook

clazzfish.monitor.AbstractMonitor

clazzfish.jdbc.AbstractStatistic

clazzfish.jdbc.SqlStatistic

All Implemented Interfaces:

Shutdownable, AbstractStatisticMBean, SqlStatisticMBean, AbstractMonitorMBean, Runnable

public class SqlStatistic
extends AbstractStatistic
implements SqlStatisticMBean

This class monitors and measures SQL statements.

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

Method Summary

Modifier and Type	Method	Description
URI	exportCSV()	Exports the SQL statistic as CSV.
URI	getExportURI()	Returns the URI where the statistic should be exported to.
static SqlStatistic	getInstance()
CsvXPorter	getXPorter()
void	importCSV(URI csvURI)	Imports the statistics from the given URI.
void	reset()	To start a new statistic call this method.
void	setXPorter(CsvXPorter xPorter)
static ProfileMonitor	start(String sql)	Start the monitor for the given SQL statement.
static void	stop(ProfileMonitor mon, String command)	Stops the given 'mon' and logs the given command with the needed time if debug is enabled.
static void	stop(ProfileMonitor mon, String command, Object returnValue)	Stops the given 'mon' and logs the given command with the needed time if debug is enabled.
String	toString()	As the toString implementation the name of the registered MBean is used.

Methods inherited from class AbstractStatistic

dumpMe, dumpMe, getCsvLines, getMaxAvg, getMaxAvgLabel, getMaxAvgStatistic, getMaxHits, getMaxHitsLabel, getMaxHitsStatistic, getMaxMax, getMaxMaxLabel, getMaxMaxStatistic, getMaxSize, getMaxTotal, getMaxTotalLabel, getMaxTotalStatistic, getMonitor, getMonitors, getSortedMonitors, getStatistics, logMe, resetRootMonitor, setMaxSize, startProfileMonitorFor

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.
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, getDumpDir, isMBean, registerMeAsMBean, registerMeAsMBean, run, 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.
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.
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

Method Details

getInstance

public static SqlStatistic getInstance()

getXPorter

public CsvXPorter getXPorter()

setXPorter

public void setXPorter(CsvXPorter xPorter)

reset

public void reset()

To start a new statistic call this method. In contradiction to AbstractStatistic.reset() old ProfileMonitors will removed.

Specified by:

reset in interface AbstractStatisticMBean

Overrides:

reset in class AbstractStatistic

start

public static ProfileMonitor start(String sql)

Start the monitor for the given SQL statement.

Parameters:

sql - the SQL statement to be monitored

Returns:

the started profile monitor

stop

public static void stop(ProfileMonitor mon,
 String command)

Stops the given 'mon' and logs the given command with the needed time if debug is enabled.

Parameters:

mon - the mon

command - the command

stop

public static void stop(ProfileMonitor mon,
 String command,
 Object returnValue)

Stops the given 'mon' and logs the given command with the needed time if debug is enabled.

Parameters:

mon - the monitor

command - the SQL command

returnValue - the monitored return value

exportCSV

public URI exportCSV()
              throws IOException

Exports the SQL statistic as CSV.

Overrides:

exportCSV in class AbstractMonitor

Returns:

the URI where the statistic is exported

Throws:

IOException - in case of IO problems

Since:

3.0

getExportURI

public URI getExportURI()

Description copied from interface: SqlStatisticMBean

Returns the URI where the statistic should be exported to.

Specified by:

getExportURI in interface SqlStatisticMBean

Returns:

export URI

importCSV

public void importCSV(URI csvURI)

Imports the statistics from the given URI.

Parameters:

csvURI - URI where the statistic should be imported from

toString

public String toString()

Description copied from class: AbstractMonitor

As the toString implementation the name of the registered MBean is used.

Overrides:

toString in class AbstractMonitor

Returns:

the registered MBean name