org.openspaces.admin
Interface StatisticsMonitor

All Known Subinterfaces:

Admin, OperatingSystem, OperatingSystems, ProcessingUnit, ProcessingUnitInstance, ProcessingUnits, Space, SpaceInstance, Spaces, Transport, Transports, VirtualMachine, VirtualMachines

public interface StatisticsMonitor

Components implement this interface indicating that they can be monitored for statistics.

Components will allow to get their respective statistics without being monitoring (while caching the calls for the provided statistics interval).

Monitoring statistics is only required when wanting to receive statistics change events.

The statistics interval controls either for how long the latest statistics call will be cached, or, when monitoring is enabled, the interval the statistics will be pooled. Its default value is 5 seconds.

Author:

kimchy

Field Summary

static int	DEFAULT_HISTORY_SIZE The default history size stored in statistics.
static long	DEFAULT_MONITOR_INTERVAL The default statistics interval which is 5 seconds.

Method Summary

boolean	isMonitoring() Returns true if statistics are now being monitored.
void	setStatisticsHistorySize(int historySize) Sets the history size of number of statistics stored.
void	setStatisticsInterval(long interval, TimeUnit timeUnit) Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.
void	startStatisticsMonitor() Starts the statistics monitor, starting a scheduled monitor that polls for statistics.
void	stopStatisticsMonitor() Stops the statistics monitor.

Field Detail

DEFAULT_MONITOR_INTERVAL

static final long DEFAULT_MONITOR_INTERVAL

The default statistics interval which is 5 seconds.

See Also:

Constant Field Values

DEFAULT_HISTORY_SIZE

static final int DEFAULT_HISTORY_SIZE

The default history size stored in statistics.

See Also:

Constant Field Values

Method Detail

setStatisticsInterval

void setStatisticsInterval(long interval,
                           TimeUnit timeUnit)

Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.

Since:

8.0 Restarts monitoring, with new interval, if no other party is already monitoring for statistics.

setStatisticsHistorySize

void setStatisticsHistorySize(int historySize)

Sets the history size of number of statistics stored.

startStatisticsMonitor

void startStatisticsMonitor()

Starts the statistics monitor, starting a scheduled monitor that polls for statistics. Monitoring is required only when wanting to receive statistics change events.

Since:

8.0 Restarts monitoring if no other party is already monitoring for statistics.

stopStatisticsMonitor

void stopStatisticsMonitor()

Stops the statistics monitor.

Since:

8.0 Stops monitoring if no other party is monitoring for statistics.

isMonitoring

boolean isMonitoring()

Returns true if statistics are now being monitored.