Skip navigation links

com.bea.wlcp.wlng.statistics.management
Interface StatisticsServiceMBean

public interface StatisticsServiceMBean

Field Summary

static CounterInfo	counterSnapshot Gets a counter snapshot for the local server.
static CounterInfo[]	counterSnapshotAll Gets a counter snapshot for the all servers in the cluster.
static int	moduleBHTUPSThreshold BHTUPS 95% warning and limit exceeded alarm threshold setting for the modules transaction group.
static int	platformBHTUPSThreshold BHTUPS 95% warning and limit exceeded alarm threshold setting for the platform transaction group.
static boolean	statisticsEnabled
static int	storeInterval Interval in number of seconds that statistics data is written to DB.

Method Summary

void	addStatisticType(int id, String name) Adds a statistic type.
void	createLicenseLimitLog(String filename, String startDate, String endDate) Creates a license limit supervision log that contains information about the busy hour transaction rate for each transaction group and day during the time period specified.
void	createWeeklyReport(String serviceProviderIdentifier, String startDate, String fileName, int decimals) Saves a weekly report to a text file.
CounterInfo	getCounterSnapshot()
CounterInfo[]	getCounterSnapshotAll() Scope: Cluster or Server
int	getCurStatisticsValue(String serverName, int statisticType, int secondsInAdvance, String serviceProviderIdentifier, String applicationIdentifier)
int	getCurStatisticsValueByUnit(String serverName, Integer statisticType, Integer valueInAdvance, String valueUnit)
int	getLastStatistics(String serverName, int statisticType, String serviceProviderIdentifier, String applicationIdentifier)
int	getModuleBHTUPSThreshold()
int	getPlatformBHTUPSThreshold()
StatisticsInfo[]	getStatistics(String serverName, int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier) Gets statistics based on filter criteria for a specific account.
boolean	getStatisticsEnabled()
int	getStatisticsValue(String serverName, int statisticType, long fromDateInMilSeconds, long toDateInMilSeconds, String serviceProviderIdentifier, String applicationIdentifier)
int	getStoreInterval()
String	getSystemStatistics(int minutes) Gets system statistics for the last minute(s).
StatInfo[]	listStatistics(int statisticType, long fromDate, long toDate, String serviceProviderIdentifier, String applicationIdentifier) Gets statistics based on filter criteria for a specific account.
StatisticTypeDescriptor[]	listStatisticTypeDescriptors() Displays a list of all available statistics type descriptors.
String	listStatisticTypes() Removes a statistic type.
void	saveAccountStatisticsToFile(int statisticType, String fromDate, String toDate, String serviceProviderIdentifier, String applicationIdentifier, String fileName) Saves statistics data to a file grouped by account based on specified filter criteria.
void	saveStatisticsToFile(String serverName, int statisticType, String fromDate, String toDate, String fileName) Saves statistics data to a file on filter criteria.
void	setModuleBHTUPSThreshold(int threshold)
void	setPlatformBHTUPSThreshold(int threshold)
void	setStatisticsEnabled(boolean statisticsEnabled)
void	setStoreInterval(int seconds)

Field Detail

counterSnapshot

public static final CounterInfo counterSnapshot

Gets a counter snapshot for the local server. Note that the counters are reset periodically and only new statistics information since the last reset is included in the result.

Scope: Cluster or Server

counterSnapshotAll

public static final CounterInfo[] counterSnapshotAll

Gets a counter snapshot for the all servers in the cluster. Note that the counters are reset periodically and only new statistics information since the last reset is included in the result.

Scope: Cluster or Server

moduleBHTUPSThreshold

public static final int moduleBHTUPSThreshold

BHTUPS 95% warning and limit exceeded alarm threshold setting for the modules transaction group. Setting threshold to 0 disables warning and exceeded threshold alarm.

Scope: Cluster

See Also:

Constant Field Values

platformBHTUPSThreshold

public static final int platformBHTUPSThreshold

BHTUPS 95% warning and limit exceeded alarm threshold setting for the platform transaction group. Setting threshold to 0 disables warning and exceeded threshold alarm.

Scope: Cluster

See Also:

Constant Field Values

statisticsEnabled

public static final boolean statisticsEnabled

See Also:

Constant Field Values

storeInterval

public static final int storeInterval

Interval in number of seconds that statistics data is written to DB.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

addStatisticType

public void addStatisticType(int id,
                             String name)
                      throws ManagementException

Adds a statistic type. Used to add a statistics type for custom communication services.

Scope: Cluster

Parameters:

id - Id for this statistics. The ID must not be already used.

name - Descriptive name for the statistics type.

Throws:

ManagementException

createLicenseLimitLog

public void createLicenseLimitLog(String filename,
                                  String startDate,
                                  String endDate)
                           throws ManagementException

Creates a license limit supervision log that contains information about the busy hour transaction rate for each transaction group and day during the time period specified.

Scope: Cluster

Parameters:

filename - Name of file. The file will be created on the local file system of the server. Must include an absolute path. The file must not already exist. If it already exists, the operation will fail.

startDate - Start date specified as yyyy-mm-dd.

endDate - End date specified as yyyy-mm-dd.

Throws:

ManagementException

createWeeklyReport

public void createWeeklyReport(String serviceProviderIdentifier,
                               String startDate,
                               String fileName,
                               int decimals)
                        throws ManagementException

Saves a weekly report to a text file.

Scope: Cluster or Server

Parameters:

serviceProviderIdentifier - Service provider account. Leave empty to include all service provider account in the report.

startDate - From date specified as yyyy-mm-dd hh:mm.

fileName - Name of file. The file will be created on the local file system of the server. Must include an absolute path. The file must not already exist. If it already exists, the operation will fail.

decimals - Number of decimals for transactions/second.

Throws:

ManagementException

getCounterSnapshot

public CounterInfo getCounterSnapshot()
                               throws ManagementException

Returns:

Number of transactions since last reset grouped by service provider, application and transaction type.

Scope: Cluster or Server

Throws:

ManagementException

getCounterSnapshotAll

public CounterInfo[] getCounterSnapshotAll()
                                    throws ManagementException

Scope: Cluster or Server

Returns:

Number of transactions since last reset grouped by server, service provider, application and transaction type.

Throws:

ManagementException

getCurStatisticsValue

public int getCurStatisticsValue(String serverName,
                                 int statisticType,
                                 int secondsInAdvance,
                                 String serviceProviderIdentifier,
                                 String applicationIdentifier)
                          throws ManagementException

Throws:

ManagementException

getCurStatisticsValueByUnit

public int getCurStatisticsValueByUnit(String serverName,
                                       Integer statisticType,
                                       Integer valueInAdvance,
                                       String valueUnit)
                                throws ManagementException

Throws:

ManagementException

getLastStatistics

public int getLastStatistics(String serverName,
                             int statisticType,
                             String serviceProviderIdentifier,
                             String applicationIdentifier)
                      throws ManagementException

Throws:

ManagementException

getModuleBHTUPSThreshold

public int getModuleBHTUPSThreshold()
                             throws ManagementException

Throws:

ManagementException

getPlatformBHTUPSThreshold

public int getPlatformBHTUPSThreshold()
                               throws ManagementException

Throws:

ManagementException

getStatistics

public StatisticsInfo[] getStatistics(String serverName,
                                      int statisticType,
                                      String fromDate,
                                      String toDate,
                                      String serviceProviderIdentifier,
                                      String applicationIdentifier)
                               throws ManagementException

Gets statistics based on filter criteria for a specific account.

Scope: Cluster or Server

Parameters:

serverName - The server that generated the statistics (optional). to display statistics generated in all servers.

statisticType - Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.

fromDate - From date specified as yyyy-mm-dd hh:mm (optional). display all statistics up to the date and time specified in toDate.

toDate - To date specified as yyyy-mm-dd hh:mm (optional). display all statistics generated from the date and time specified in fromDate up to current date and time.

serviceProviderIdentifier - Service provider account (optional). Leave empty to wildcard.

applicationIdentifier - Application account (optional). Leave empty to wildcard.

Returns:

Statistics information.

Throws:

ManagementException

getStatisticsEnabled

public boolean getStatisticsEnabled()

getStatisticsValue

public int getStatisticsValue(String serverName,
                              int statisticType,
                              long fromDateInMilSeconds,
                              long toDateInMilSeconds,
                              String serviceProviderIdentifier,
                              String applicationIdentifier)
                       throws ManagementException

Throws:

ManagementException

getStoreInterval

public int getStoreInterval()
                     throws ManagementException

Throws:

ManagementException

getSystemStatistics

public String getSystemStatistics(int minutes)
                           throws ManagementException

Gets system statistics for the last minute(s).

Scope: Cluster or Server

Parameters:

minutes - The number of minutes relative to the current time.

Returns:

Statistics information.

Throws:

ManagementException

listStatistics

public StatInfo[] listStatistics(int statisticType,
                                 long fromDate,
                                 long toDate,
                                 String serviceProviderIdentifier,
                                 String applicationIdentifier)
                          throws ManagementException

Gets statistics based on filter criteria for a specific account.

Scope: Cluster or Server

Parameters:

statisticType - Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.

fromDate - From date in milliseconds. Use -1 for no lower date limit.

toDate - To date in milliseconds. Use -1 for no upper date limit.

serviceProviderIdentifier - Service provider account (optional)

applicationIdentifier - Application account (optional)

Returns:

Statistics information.

Throws:

ManagementException

listStatisticTypeDescriptors

public StatisticTypeDescriptor[] listStatisticTypeDescriptors()
                                                       throws ManagementException

Displays a list of all available statistics type descriptors. The descriptors contain information on transactionTypeName and transactionTypeID.

Scope: Cluster

Throws:

ManagementException

listStatisticTypes

public String listStatisticTypes()
                          throws ManagementException

Removes a statistic type.

Scope: Cluster or Server

Returns:

All statistic type IDs including the descriptive names.

Throws:

ManagementException

saveAccountStatisticsToFile

public void saveAccountStatisticsToFile(int statisticType,
                                        String fromDate,
                                        String toDate,
                                        String serviceProviderIdentifier,
                                        String applicationIdentifier,
                                        String fileName)
                                 throws ManagementException

Saves statistics data to a file grouped by account based on specified filter criteria.

Scope: Cluster or Server

Parameters:

statisticType - Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.

fromDate - From date specified as yyyy-mm-dd hh:mm (optional). Leave empty for all statistics up to the date and time specified in toDate.

toDate - To date specified as yyyy-mm-dd hh:mm (optional). Leave empty for all statistics generated from the date and time specified in fromDate up to current date and time.

serviceProviderIdentifier - Service provider account (optional). Leave empty for no filtering.

applicationIdentifier - Application account (optional). Leave empty for no filtering.

fileName - Name of file. The file will be created on the local file system of the server. Must include an absolute path. The file must not already exist. If it does already exist, the method will fail.

Throws:

ManagementException

saveStatisticsToFile

public void saveStatisticsToFile(String serverName,
                                 int statisticType,
                                 String fromDate,
                                 String toDate,
                                 String fileName)
                          throws ManagementException

Saves statistics data to a file on filter criteria.

Scope: Cluster or Server

Parameters:

serverName - The server that generated the statistics. (optional). Leave empty for statistics generated in all servers.

statisticType - Type of statistics. Use listStatisticTypes to obtain available types. Use -1 to get statistics for all available types.

fromDate - From date specified as yyyy-mm-dd hh:mm (optional). Leave empty for all statistics up to the date and time specified in toDate.

toDate - To date specified as yyyy-mm-dd hh:mm (optional). Leave empty for all statistics generated from the date and time specified in fromDate up to current date and time.

fileName - Name of file. The file will be created on the local file system of the server. Must include an absolute path. The file must not already exist. If it does already exist, the method will fail.

Throws:

ManagementException

setModuleBHTUPSThreshold

public void setModuleBHTUPSThreshold(int threshold)
                              throws ManagementException

Throws:

ManagementException

setPlatformBHTUPSThreshold

public void setPlatformBHTUPSThreshold(int threshold)
                                throws ManagementException

Throws:

ManagementException

setStatisticsEnabled

public void setStatisticsEnabled(boolean statisticsEnabled)

setStoreInterval

public void setStoreInterval(int seconds)
                      throws ManagementException

Throws:

ManagementException

Skip navigation links