com.avaje.ebeaninternal.server.jmx

Interface MAdminAutofetchMBean

All Known Implementing Classes:

MAdminAutofetch

public interface MAdminAutofetchMBean

Method Summary

Methods

Modifier and Type	Method and Description
int	clearProfilingInfo() Clear all the profiling information.
int	clearTunedQueryInfo() Clear all the tuned query info.
String	collectUsageViaGC() Fire a garbage collection (hint to the JVM).
String	getMode() This controls whether autoFetch is used when it has not been explicitly set on a query via Query#setAutoFetch(boolean).
String	getModeOptions() List of the valid implicit modes that can be used.
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() Returns the rate which profiling is collected.
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.
boolean	isProfiling() Return true if profiling is enabled.
boolean	isQueryTuning() Return true if autoFetch is enabled.
void	setMode(String mode) Set the auto fetch mode used when a query has not had Query#setAutoFetch(boolean).
void	setProfiling(boolean enable) Set to true to enable profiling.
void	setProfilingBase(int profilingMaxThreshold) Set a max number of queries to profile per query point.
void	setProfilingMin(int autoFetchMinThreshold) Set the minimum number of queries profiled per query point before autoFetch will automatically tune the queries.
void	setProfilingRate(double rate) Set the rate at which profiling is collected after the base.
void	setQueryTuning(boolean enable) Set to true to enable autoFetch.
String	updateTunedQueryInfo() This will take the current profiling information and update the "tuned query detail".

Method Detail

isProfiling

boolean isProfiling()

Return true if profiling is enabled.

setProfiling

void setProfiling(boolean enable)

Set to true to enable profiling.

isQueryTuning

boolean isQueryTuning()

Return true if autoFetch is enabled.

setQueryTuning

void setQueryTuning(boolean enable)

Set to true to enable autoFetch.

getMode

String getMode()

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

getModeOptions

String getModeOptions()

List of the valid implicit modes that can be used.

setMode

void setMode(String mode)

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

getProfilingBase

int getProfilingBase()

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.

setProfilingBase

void setProfilingBase(int profilingMaxThreshold)

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.

getProfilingRate

double getProfilingRate()

Returns the rate which profiling is collected. This is an int between 0 and 100.

setProfilingRate

void setProfilingRate(double rate)

Set the rate at which profiling is collected after the base.

Parameters:

rate - a int between 0 and 100.

getProfilingMin

int getProfilingMin()

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.

setProfilingMin

void setProfilingMin(int autoFetchMinThreshold)

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.

collectUsageViaGC

String collectUsageViaGC()

Fire a garbage collection (hint to the JVM). Assuming garbage collection fires this will gather the usage profiling information.

updateTunedQueryInfo

String updateTunedQueryInfo()

This will take the current profiling information and update the "tuned query detail".

This is done periodically and can also be manually invoked.

clearTunedQueryInfo

int clearTunedQueryInfo()

Clear all the tuned query info.

Should only need do this for testing and playing around.

Returns:

the amount of tuned query information cleared.

clearProfilingInfo

int clearProfilingInfo()

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.

Returns:

the amount of profiled information cleared.

getTotalTunedQueryCount

int getTotalTunedQueryCount()

Return the number of queries tuned by AutoFetch.

getTotalTunedQuerySize

int getTotalTunedQuerySize()

Return the size of the TuneQuery map.

getTotalProfileSize

int getTotalProfileSize()

Return the size of the profile map.