com.avaje.ebeaninternal.server.autofetch

Class DefaultAutoFetchManager

java.lang.Object

com.avaje.ebeaninternal.server.autofetch.DefaultAutoFetchManager

All Implemented Interfaces:

NodeUsageListener, AutoFetchManager, Serializable

public class DefaultAutoFetchManager
extends Object
implements AutoFetchManager, Serializable

The manager of all the usage/query statistics as well as the tuned fetch information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultAutoFetchManager(String fileName)

Method Summary

Methods

Modifier and Type	Method and Description
int	clearProfilingInfo() Clear all the profiling information.
void	clearQueryStatistics() Clear the query execution statistics.
int	clearTunedQueryInfo() Clear all the tuned query info.
void	collectNodeUsage(NodeUsageCollector usageCollector) Collect usage statistics from a node in the object graph.
void	collectQueryInfo(ObjectGraphNode node, long beans, long micros) Gather query execution statistics.
String	collectUsageViaGC(long waitMillis) Ask for a System.gc() so that we gather node usage information.
AutofetchMode	getMode() This controls whether autoFetch is used when it has not been explicitly set on a query via Query#setAutoFetch(boolean).
int	getProfilingBase() Return the max number of queries profiled (per query point).
int	getProfilingMin() Return the minimum number of queries profiled before autoFetch will start automatically tuning the queries.
double	getProfilingRate() Return the profiling rate (int between 0 and 100).
Statistics	getStatistics(String originKey) Return the current Statistics for a given originKey key.
int	getTotalProfileSize() Return the size of the profile map.
int	getTotalTunedQueryCount() Return the number of queries tuned by AutoFetch.
int	getTotalTunedQuerySize() Return the size of the TuneQuery map.
TunedQueryInfo	getTunedQueryInfo(String originKey) Return the current Tuned query info for a given origin key.
boolean	isProfiling() Return true if profiling is enabled.
boolean	isQueryTuning() Return true if automatic query tuning is enabled.
Iterator<Statistics>	iterateStatistics() Iterate the node usage statistics.
Iterator<TunedQueryInfo>	iterateTunedQueryInfo() Iterate the tuned fetch info.
void	serialize()
void	setMode(AutofetchMode mode) Set the auto fetch mode used when a query has not had Query#setAutoFetch(boolean).
void	setOwner(SpiEbeanServer server, ServerConfig serverConfig) Set up this profile listener before it is active.
void	setProfiling(boolean profiling) When the application is running, BEFORE turning off profiling you probably should call collectUsageViaGC() as there is a delay (waiting for garbage collection) collecting usage profiling information.
void	setProfilingBase(int profilingBase) Set a max number of queries to profile per query point.
void	setProfilingMin(int profilingMin) Set the minimum number of queries profiled per query point before autoFetch will automatically tune the queries.
void	setProfilingRate(double rate) Set the profiling rate (int between 0 and 100).
void	setQueryTuning(boolean queryTuning) Set to true to enable automatic query tuning.
void	shutdown() Shutdown the listener.
String	toString()
boolean	tuneQuery(SpiQuery<?> query) Auto tune the query and enable profiling.
String	updateTunedQueryInfo() Update the tuned fetch plans from the current usage information.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAutoFetchManager

public DefaultAutoFetchManager(String fileName)

Method Detail

setOwner

public void setOwner(SpiEbeanServer server,
            ServerConfig serverConfig)

Set up this profile listener before it is active.

Specified by:

setOwner in interface AutoFetchManager

clearQueryStatistics

public void clearQueryStatistics()

Description copied from interface: AutoFetchManager

Clear the query execution statistics.

Specified by:

clearQueryStatistics in interface AutoFetchManager

getTotalTunedQueryCount

public int getTotalTunedQueryCount()

Return the number of queries tuned by AutoFetch.

Specified by:

getTotalTunedQueryCount in interface AutoFetchManager

getTotalTunedQuerySize

public int getTotalTunedQuerySize()

Return the size of the TuneQuery map.

Specified by:

getTotalTunedQuerySize in interface AutoFetchManager

getTotalProfileSize

public int getTotalProfileSize()

Return the size of the profile map.

Specified by:

getTotalProfileSize in interface AutoFetchManager

clearTunedQueryInfo

public int clearTunedQueryInfo()

Description copied from interface: AutoFetchManager

Clear all the tuned query info.

Should only need do this for testing and playing around.

Specified by:

clearTunedQueryInfo in interface AutoFetchManager

clearProfilingInfo

public int clearProfilingInfo()

Description copied from interface: AutoFetchManager

Clear all the profiling information.

This means the profiling information will need to be re-gathered.

Should only need do this for testing and playing around.

Specified by:

clearProfilingInfo in interface AutoFetchManager

serialize

public void serialize()

getTunedQueryInfo

public TunedQueryInfo getTunedQueryInfo(String originKey)

Return the current Tuned query info for a given origin key.

Specified by:

getTunedQueryInfo in interface AutoFetchManager

getStatistics

public Statistics getStatistics(String originKey)

Return the current Statistics for a given originKey key.

Specified by:

getStatistics in interface AutoFetchManager

iterateTunedQueryInfo

public Iterator<TunedQueryInfo> iterateTunedQueryInfo()

Description copied from interface: AutoFetchManager

Iterate the tuned fetch info.

This should be a read only iteration.

Specified by:

iterateTunedQueryInfo in interface AutoFetchManager

iterateStatistics

public Iterator<Statistics> iterateStatistics()

Description copied from interface: AutoFetchManager

Iterate the node usage statistics.

This should be a read only iteration.

Specified by:

iterateStatistics in interface AutoFetchManager

isProfiling

public boolean isProfiling()

Description copied from interface: AutoFetchManager

Return true if profiling is enabled.

Specified by:

isProfiling in interface AutoFetchManager

setProfiling

public void setProfiling(boolean profiling)

When the application is running, BEFORE turning off profiling you probably should call collectUsageViaGC() as there is a delay (waiting for garbage collection) collecting usage profiling information.

Specified by:

setProfiling in interface AutoFetchManager

isQueryTuning

public boolean isQueryTuning()

Description copied from interface: AutoFetchManager

Return true if automatic query tuning is enabled.

Specified by:

isQueryTuning in interface AutoFetchManager

setQueryTuning

public void setQueryTuning(boolean queryTuning)

Description copied from interface: AutoFetchManager

Set to true to enable automatic query tuning.

Specified by:

setQueryTuning in interface AutoFetchManager

getProfilingRate

public double getProfilingRate()

Description copied from interface: AutoFetchManager

Return the profiling rate (int between 0 and 100).

Specified by:

getProfilingRate in interface AutoFetchManager

getMode

public AutofetchMode getMode()

Description copied from interface: AutoFetchManager

This controls whether autoFetch is used when it has not been explicitly set on a query via Query#setAutoFetch(boolean).

Specified by:

getMode in interface AutoFetchManager

setMode

public void setMode(AutofetchMode mode)

Description copied from interface: AutoFetchManager

Set the auto fetch mode used when a query has not had Query#setAutoFetch(boolean).

Specified by:

setMode in interface AutoFetchManager

setProfilingRate

public void setProfilingRate(double rate)

Description copied from interface: AutoFetchManager

Set the profiling rate (int between 0 and 100).

Specified by:

setProfilingRate in interface AutoFetchManager

getProfilingBase

public int getProfilingBase()

Description copied from interface: AutoFetchManager

Return the max number of queries profiled (per query point).

The number of queries profiled is collected per query point. Once a query point has profiled this number of queries it does not profile any more.

Specified by:

getProfilingBase in interface AutoFetchManager

setProfilingBase

public void setProfilingBase(int profilingBase)

Description copied from interface: AutoFetchManager

Set a max number of queries to profile per query point.

This number should provide a level of confidence that no more profiling is required for this query point.

Specified by:

setProfilingBase in interface AutoFetchManager

getProfilingMin

public int getProfilingMin()

Description copied from interface: AutoFetchManager

Return the minimum number of queries profiled before autoFetch will start automatically tuning the queries.

This could be one which means start autoFetch tuning after the first profiling information is collected.

Specified by:

getProfilingMin in interface AutoFetchManager

setProfilingMin

public void setProfilingMin(int profilingMin)

Description copied from interface: AutoFetchManager

Set the minimum number of queries profiled per query point before autoFetch will automatically tune the queries.

Increasing this number will mean more profiling is collected before autoFetch starts tuning the query.

Specified by:

setProfilingMin in interface AutoFetchManager

shutdown

public void shutdown()

Shutdown the listener.

We should try to collect the usage statistics by calling a System.gc(). This is necessary for use with short lived applications where garbage collection may not otherwise occur at all.

Specified by:

shutdown in interface AutoFetchManager

collectUsageViaGC

public String collectUsageViaGC(long waitMillis)

Ask for a System.gc() so that we gather node usage information.

Really only want to do this sparingly but useful just prior to shutdown for short run application where garbage collection may otherwise not occur at all.

waitMillis will do a thread sleep to give the garbage collection a little time to do its thing assuming we are shutting down the VM.

If waitMillis is -1 then the defaultGarbageCollectionWait is used which defaults to 100 milliseconds.

Specified by:

collectUsageViaGC in interface AutoFetchManager

updateTunedQueryInfo

public String updateTunedQueryInfo()

Update the tuned fetch plans from the current usage information.

Specified by:

updateTunedQueryInfo in interface AutoFetchManager

tuneQuery

public boolean tuneQuery(SpiQuery<?> query)

Auto tune the query and enable profiling.

Specified by:

tuneQuery in interface AutoFetchManager

collectQueryInfo

public void collectQueryInfo(ObjectGraphNode node,
                    long beans,
                    long micros)

Gather query execution statistics. This could either be the originating query in which case the parentNode will be null, or a lazy loading query resulting from traversal of the object graph.

Specified by:

collectQueryInfo in interface AutoFetchManager

Parameters:

node - the node path in the object graph.

beans - the number of beans loaded by the query.

micros - the query executing time in microseconds

collectNodeUsage

public void collectNodeUsage(NodeUsageCollector usageCollector)

Collect usage statistics from a node in the object graph.

This is sent to use from a EntityBeanIntercept when the finalise method is called on the bean.

Specified by:

collectNodeUsage in interface NodeUsageListener

toString

public String toString()

Overrides:

toString in class Object