com.prosyst.mprm.admin.statistics

Interface StatisticsReader

public interface StatisticsReader

This service interface is a central entry point for reading/retrieving statistics. Statistics could be retrieved for the mPRM as a whole entity or could be scoped to a particular host. A statistic represents a single variable quantity. I is specified/identified via the properties group and name.

• group - this concept represents logical grouping of statistics. e.g. group memory -> (free/used/total memory). Group name shall be unique in the scope of the whole mPRM. It is directly displayed to the user so it shall be an user friendly name.
• name - this parameter represents the unique name of the quantity/measurement this statistic represents (e.g. free, used, total memory). Name shall be unique into the scope of the group. It is directly displayed to the user so it shall be an user friendly name.

Every statistic support a set of reports - a report is a statistic view of the quantity. e.g. average, minimum, maximum. These reports are mapped to a set of report names. Every report name has to be unique in the scope of the statistic. The report names are directly displayed to the user so it shall be an user friendly name.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SYSTEM_GROUP The group under which are all of the system statistics.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String groupFilter, java.lang.String nameFilter, java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter, java.lang.String hostId) Delete information for the statistics that match the filter.
Statistic	getStatistic(java.lang.String group, java.lang.String name, java.lang.String hostIds) Returns the statistic with name matching name found on hosts with id matching host ids.
java.lang.String[]	getStatisticGroups(java.lang.String hostIds) Returns the group names of all statistics found on host with the given id.
java.lang.String[]	getStatisticNames(java.lang.String group, java.lang.String hostId) Returns the names of all statistics with matching group name found on hosts with the given id.
Enumerator<Source,ManagementException>	listSources(java.lang.String groupFilter, java.lang.String nameFilter, java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter, java.lang.String hostId) List all sources found for the given source filter.
Enumerator<java.lang.String,ManagementException>	listSourceTypes(java.lang.String groupFilter, java.lang.String nameFilter, java.lang.String sourceTypeFilter, java.lang.String hostId) Returns list of filtered source types.
Enumerator<Statistic,ManagementException>	listStatistics(java.lang.String hostId) List all statistics found on host with the given id.
Enumerator<Statistic,ManagementException>	listStatistics(java.lang.String groupFilter, java.lang.String nameFilter, java.lang.String sourceTypeFilter, java.lang.String sourceNameFilter, java.lang.String hostId) List all statistics found for the given filter.

Field Detail

SYSTEM_GROUP

static final java.lang.String SYSTEM_GROUP

The group under which are all of the system statistics.

See Also:

Constant Field Values

Method Detail

listStatistics

Enumerator<Statistic,ManagementException> listStatistics(java.lang.String hostId)
                                                  throws ManagementException

List all statistics found on host with the given id.

Parameters:

hostId - host id. null stands for all hosts.

Returns:

enumerator of Statistic elements.

Throws:

ManagementException

listStatistics

Enumerator<Statistic,ManagementException> listStatistics(java.lang.String groupFilter,
                                                         java.lang.String nameFilter,
                                                         java.lang.String sourceTypeFilter,
                                                         java.lang.String sourceNameFilter,
                                                         java.lang.String hostId)
                                                  throws ManagementException

List all statistics found for the given filter.

Parameters:

groupFilter - optional wild card filter for the statistics group.

nameFilter - optional wild card filter for the statistics name.

sourceTypeFilter - optional wild card filter for the source type.

sourceNameFilter - optional wild card filter for the source name.

hostId - host id. null stands for all hosts.

Returns:

enumerator of Statistic elements.

Throws:

ManagementException

listSourceTypes

Enumerator<java.lang.String,ManagementException> listSourceTypes(java.lang.String groupFilter,
                                                                 java.lang.String nameFilter,
                                                                 java.lang.String sourceTypeFilter,
                                                                 java.lang.String hostId)
                                                          throws ManagementException

Returns list of filtered source types.

Parameters:

sourceTypeFilter - wild card source type filter.

hostId - host id this statistic is collected on. null stands for all hosts.

Returns:

filtered source types.

Throws:

ManagementException

listSources

Enumerator<Source,ManagementException> listSources(java.lang.String groupFilter,
                                                   java.lang.String nameFilter,
                                                   java.lang.String sourceTypeFilter,
                                                   java.lang.String sourceNameFilter,
                                                   java.lang.String hostId)
                                            throws ManagementException

List all sources found for the given source filter.

Parameters:

groupFilter - optional wild card filter for the statistics group.

sourceTypeFilter - optional wild card filter for the source type.

sourceNameFilter - optional wild card filter for the source name.

hostId - host id. null stands for all hosts.

Returns:

enumerator of Source elements.

Throws:

ManagementException

getStatisticGroups

java.lang.String[] getStatisticGroups(java.lang.String hostIds)
                               throws ManagementException

Returns the group names of all statistics found on host with the given id.

Parameters:

hostId - host id. null stands for all hosts.

Returns:

statistic groups.

Throws:

ManagementException

getStatisticNames

java.lang.String[] getStatisticNames(java.lang.String group,
                                     java.lang.String hostId)
                              throws ManagementException

Returns the names of all statistics with matching group name found on hosts with the given id.

Parameters:

group - if group is null the parameter is not taken in account and all names are returned.

hostId - host id. null stands for all hosts.

Returns:

statistic names.

Throws:

ManagementException

getStatistic

Statistic getStatistic(java.lang.String group,
                       java.lang.String name,
                       java.lang.String hostIds)
                throws ManagementException

Returns the statistic with name matching name found on hosts with id matching host ids.

Parameters:

group - the group of the statistics

name - statistics with matching name will be returned.

hostId - host id this statistic is collected on. null stands for all hosts.

Returns:

statistic matching the name and available for the hosts matching hostIds.

Throws:

ManagementException

delete

void delete(java.lang.String groupFilter,
            java.lang.String nameFilter,
            java.lang.String sourceTypeFilter,
            java.lang.String sourceNameFilter,
            java.lang.String hostId)
     throws ManagementException

Delete information for the statistics that match the filter.

Parameters:

groupFilter - optional wild card filter for the statistics group.

sourceTypeFilter - optional wild card filter for the source type.

sourceNameFilter - optional wild card filter for the source name.

hostId - host id. null stands for all hosts.

Throws:

ManagementException