sirius.kernel.health

Class Microtiming

java.lang.Object

sirius.kernel.health.Microtiming

public class Microtiming
extends Object

Performance measurement framework which can be used in development as well as in production systems.

Can be used to identify bottlenecks or to analyze system performance to measure the average execution time of different tasks.

Once the microtiming framework is enabled it will be notified by other frameworks as defined tasks are executed. The execution times are combined and can be queried using getTimings().

An example might be an SQL query which is executed in a loop to perform a file import. Since the SQL-Query is always the same (in case or a prepared statement) the execution times will be added to an average which will be stored until the next call to Microtiming.getTimings().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Microtiming.Timing Simple value class which represents a measured timing.

Method Summary

Modifier and Type	Method and Description
static long	getLastReset() Returns the timestamp of the last reset
static List<Microtiming.Timing>	getTimings() Returns a list of recorded timings.
static boolean	isEnabled() Checks whether the timing is enabled.
static void	setEnabled(boolean enabled) Enables/Disables the timing.
static void	submit(String category, String key, long durationInNanos) Submits a new timing for the given key.

Methods inherited from class java.lang.Object

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

Method Detail

getTimings

public static List<Microtiming.Timing> getTimings()

Returns a list of recorded timings.

This will only report timings, which changed since the last call of getTimings. Using this approach provides a kind of auto filtering which permits to enable this framework in production systems while still getting reasonable small results.

Returns:

all Microtiming.Timing values recorded which where submitted since the last call to getTimings()

submit

public static void submit(String category,
                          String key,
                          long durationInNanos)

Submits a new timing for the given key.

Adds the average to the "live set" which will be output on the next call to getTimings()

A convenient way to call this method is to use Watch.submitMicroTiming(String, String)

Parameters:

category - the category of the recorded timing. This permits grouping a microtimings of the same kind.

key - the key for which the value should be submitted

durationInNanos - the number of nanoseconds used as timing for the given key

isEnabled

public static boolean isEnabled()

Checks whether the timing is enabled.

Returns:

true if the micro timing framework is enabled or false otherwise

setEnabled

public static void setEnabled(boolean enabled)

Enables/Disables the timing.

Parameters:

enabled - determines whether the framework should be enabled or disabled

getLastReset

public static long getLastReset()

Returns the timestamp of the last reset

Returns:

returns the timestamp in milliseconds (as provided by System.currentTimeMillis()) since the last reset.