The following sections describe the statistics functionality and the operation and maintenance procedures for statistics for Oracle Communications Services Gatekeeper:
Oracle Communications Services Gatekeeper keeps usage statistics in terms of the number of transactions handled over time. Transactions are grouped into transaction types. Transaction types are used for calculating usage costs and for grouping reports. Transaction types are in turn grouped into different categories. For more information on transaction types, see Oracle Communications Services Gatekeeper Licensing, a separate document in this set.
Statistics are only generated by communication services. Verification mechanisms ensure that all network protocol plug-ins have the statistics aspects applied. This verification takes place when the plug-in is deployed into Oracle Communications Services Gatekeeper.
Statistics are held in an in-memory store and flushed to database at a given time interval. Statistics reports are created based on information in the database.
It is possible to get a snapshot of the current status of the transaction, or request, counters. This information is fetched from the in-memory store.
These report types are available:
Statistics are used to generate reports filtered on a number of parameters:
Note: | All combinations of the above are not supported. |
This report is created by Operation: getSystemStatistics. The output is presented in the console.
This report is created by Operation: saveStatisticsToFile. The format is adapted for programmatic processing of the file.
The weekly report is a pre-defined report. It shows the total number of transactions through Oracle Communications Services Gatekeeper hour by hour during a specified week. It also shows total usage for each day and the average transaction rate (transactions/second) during the busy hour of each day. The busy hour is defined as the 60 minutes during which the largest number of transactions are handled, and does not depend on clock hours. Any 60 minute period (5 minute intervals are used) can be identified as the busy hour.
A weekly system statistics report shows:
This report is stored on file.
A transaction usage log (called the license_limit log) can be extracted from Oracle Communications Services Gatekeeper, which records the transactions on which usage costs are based. The log file contains a set of entries, where each entry represents the average transactions per second during the busy hour of a 24-hour period starting at 12:00 AM and ending 11:59 PM the previous day.
The transaction usage log report is an XML file with a header and a footer.
<start> </start>
<end> </end>
<log_entry>
</log_entry>
<checksum>
</checksum>
All information is contained within the tags <transaction_limit_log>
.
A header, encapsulated by the tag <header>
, contains information on the time period over which the log is generated, with a start and end date in the tags <start>
and <end>
, respectively. The format is DD-MM-YYYY.
Directly following the tag </end>
, one or more log entries are found in the tag <log_entry>
.
There is one <log_entry>
created for each day and transaction type.
This tag contains a set of attributes:
A checksum is contained in the tag <checksum>
. This tag contains a checksum created based on the content of the file. The checksum is used for validating that the file has not been changed.
<transaction_limit_log>
<start>2006-01-01</start>
<end>2006-01-31</end>
<log_entry group="BEA-modules" start="2007-01-01 13:45" end="2007-01-01 14:45" tps="27.35" limit="50" exceeded="false"/>
<checksum>f8b904410896b3f92159524c6c68</checksum>
</transaction_limit_log>
For more information about licensing, see section Transaction Based Licensing in Oracle Communications Services Gatekeeper Licensing.
Counter snapshots are a real-time snapshot of the statistics counters, to see the counter snapshot for the local server, use Attribute: CounterSnapshot (r)
The snapshot is organized into different categories.
The output is in the form of key value pairs, described below.
Managed object: Container ServicesStatisticsService
MBean: com.bea.wlcp.wlng.statistics.management.StatisticsServiceMBean
Below is a list of attributes and operations for configuration and maintenance:
Displays a snapshot with information about all statistics-related counters for the chosen Oracle Communications Services Gatekeeper server.
The information is useful for analyzing runtime traffic and, by invoking it periodically, can be used to get an approximate value of the traffic throughput. See Counter Snapshots.
Note: | The counters are reset periodically. |
Specifies how often statistics data is persisted to the database.
Specifies the TUPS limit alarm threshold for Oracle modules. The value of 0 means no alarms.
Specifies the TUPS limit alarm threshold for platform modules The value of 0 means no alarms.
Adds a statistic type. Used to add a statistics type for custom communication services.
addStatisticType(Id: int, Name: String)
Creates a transaction usage supervision log that contains information about the busy hour transaction rate for each transaction group and day during a given time period.
createLicenseLimitLog(filename: String, startDate: String, endDate: String)
Creates a weekly report. See Weekly System Report for a description of the report.
createWeeklyReport(SpAccountId: String, StartDate: String, FileName: String, Decimals: int)
|
|||
The filename for the report. Must include an absolute path. The file is created on the local file system of the selected server.
|
|||
Displays a detailed statistics report for a specific service provider and application. Wildcards and filters apply.
getStatistics(ServerName: String, StatisticType: String, fromDate: String, toDate: String
)
Specifies the statistics type ID for the statistics type to display. See Operation: listStatisticTypes.
|
|||
|
|||
|
|||
Displays a summary of system statistics for the last minute (s). See Overview of Statistics Reports for information on output format.
getSystemStatistics(minutes: int)
Displays a list of all available statistics type descriptors. The descriptors contain information on transactionTypeName and transactionTypeID.
listStatisticTypeDescriptors()
Specifies the statistics types included in the statistics reports.
listStatisticTypes()
removeStatisticType(statisticsType: int)
Saves a statistics report to file. Filters can be applied on service provider ID and application ID. The report is grouped by account.
saveAccountStatisticsToFile(StatisticType: String, fromDate: String, toDate: String, serviceProviderIdentifier String, applicationIdentifier: String, filename: String)
|
|||
|
|||
|
|||
Specifies the filename for the report. Must include an absolute path. The file is created on the local file system of the selected server.
|
Saves a statistics report to file.
saveStatisticsToFile(serverName: String, StatisticType: String, fromDate: String, toDate: String, filename: String)
|
|||
|
|||
|
|||
Specifies the filename for the report. Must include an absolute path. The file is created on the local file system of the selected server.
|
A set of transaction types are defined for the communication services that come as a part of Oracle Communications Services Gatekeeper. The transaction type TRANSACTION_TYPE_EXTENSION is used for new communication services, developed as extensions to Oracle Communications Services Gatekeeper.
Which events generate which statistics for a certain transaction type are described in Oracle Communications Services Gatekeeper C o mmunication Service Reference, in the sub-section Statistics for the communication service in question.
The information includes correlation maps between methods being invoked from either an application or the telecom network and the corresponding transaction type, see the sub-section Statistics in Oracle Communications Services Gatekeeper Communication Service Reference.