com.j_spaces.core.admin

Interface StatisticsAdmin

All Superinterfaces:

Remote

All Known Implementing Classes:

JSpaceAdminImpl, JSpaceAdminProxy, SpaceImpl

public interface StatisticsAdmin
extends Remote

Provides a space statistics API.

Version:

4.0

Author:

Michael Konnikov

Method Summary

Modifier and Type	Method and Description
StatisticsHolder	getHolder()
Map<String,Object>	getMetricSnapshots(Collection<String> prefixes)
Map<Integer,StatisticsContext>	getStatistics() Returns statistics repository that contains a map of operation codes to StatisticsContext objects for all filter operation codes.
StatisticsContext	getStatistics(int operationCode) Returns a StatisticsContext for specific filter operation code.
Map<Integer,StatisticsContext>	getStatistics(Integer[] operationCodes) Returns statistics repository that contains a map of operation codes to StatisticsContext objects for passed specific filter operation codes.
long	getStatisticsSamplingRate() Checks statistics sampling rate.
String[]	getStatisticsStringArray() Returns a string array contains statistics values for each operation.
boolean	isStatisticsAvailable() Checks if space statistics is available.
void	setStatisticsSamplingRate(long rate) Set statistics sampling rate.

Method Detail

isStatisticsAvailable

boolean isStatisticsAvailable()
                       throws RemoteException

Checks if space statistics is available.

Returns:

true if space statistics is available

Throws:

RemoteException - if a communication error occurs

getStatisticsStringArray

String[] getStatisticsStringArray()
                           throws StatisticsNotAvailable,
                                  RemoteException

Returns a string array contains statistics values for each operation. For example: WRITE count: 10000, average time for last 2 seconds is 4293.1 READ count: 10000, average time for last 2 seconds is 4293.1

Returns:

array of Strings that represents the space statistics

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

setStatisticsSamplingRate

void setStatisticsSamplingRate(long rate)
                        throws StatisticsNotAvailable,
                               RemoteException

Set statistics sampling rate.

Parameters:

rate - the rate to sample the space for statistics

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

getStatisticsSamplingRate

long getStatisticsSamplingRate()
                        throws StatisticsNotAvailable,
                               RemoteException

Checks statistics sampling rate.

Returns:

the statistics sampling rate

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

getStatistics

StatisticsContext getStatistics(int operationCode)
                         throws StatisticsNotAvailable,
                                RemoteException

Returns a StatisticsContext for specific filter operation code.

Parameters:

operationCode - filter operation code defined in FilterOperationCodes

Returns:

StatisticsContext for the given operation code

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

See Also:

FilterOperationCodes

getStatistics

Map<Integer,StatisticsContext> getStatistics(Integer[] operationCodes)
                                      throws StatisticsNotAvailable,
                                             RemoteException

Returns statistics repository that contains a map of operation codes to StatisticsContext objects for passed specific filter operation codes.

Parameters:

operationCodes - filter array of operation codes defined in FilterOperationCodes

Returns:

map of operation codes to StatisticsContext

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

getStatistics

Map<Integer,StatisticsContext> getStatistics()
                                      throws StatisticsNotAvailable,
                                             RemoteException

Returns statistics repository that contains a map of operation codes to StatisticsContext objects for all filter operation codes.

Returns:

map of operation codes to StatisticsContext

Throws:

StatisticsNotAvailable - when space statistics are not available

RemoteException - if a communication error occurs

getHolder

StatisticsHolder getHolder()
                    throws RemoteException

Throws:

RemoteException

getMetricSnapshots

Map<String,Object> getMetricSnapshots(Collection<String> prefixes)
                               throws RemoteException

Parameters:

prefixes - collection of metrics prefixes

Returns:

map of metrics with their values as map values

Throws:

RemoteException

Since:

12.1