Package com.ibm.websphere.objectgrid.stats

This package contains the interfaces for ObjectGrid statistic related functions.

See:
Description

Interface Summary

ActiveCountStatistic	This interface represents a CountStatistic object which also provides the count changes in the last period.
ActiveLongStatistic	This interface is used for gathering long type statistic data for a certain time period.
ActiveTimeStatistic	This interface represents a TimeStatistic object which also provides the number of time data being added in the last period.
AgentStatsModule	This interface represents a statistic module for an Agent.
CountStatistic	This interface represents statistic with a standard count measurement.
HashIndexStatsModule	This interface represents a statistic module for a HashIndex.
MapStatsModule	This interface represents a statistic module for map.
OGStatsModule	This interface represents a statistic module for an ObjectGrid.
PercentageStatistic	This interface represents a percentage Statistic.
QueryStatsModule	This interface represents a statistic module for a Query.
SessionStatsModule	This interface represents a statistic module for HTTP sessions in an ObjectGrid server.
Statistic	This inteface represents statistical data.
StatsAccessor	This interface is used to access StatsFact objects from the statistic repository and set the statistic specification for all in-process ObjectGrid instances.
StatsFact	A StatsFact interface represents an Object which contains a StatsModule.
StatsGroup	StatsGroup is a parent of a collection of StatsFact instances.
StatsModule	This interface represents a statistic module.
TimeStatistic	This interface represents a standard time measurement.

Class Summary

StatsAccessorFactory	This class is a factory for StatsAccessor objects.
StatsSpec	This class defines the statistics specification strings and integer masks to use for enabling and disabling statistics modules.

Package com.ibm.websphere.objectgrid.stats Description

This package contains the interfaces for ObjectGrid statistic related functions.

Overview

All of the ObjectGrid statistics modules are in this package. They allow the user to monitor the status of a running ObjectGrid (local or distributed). This package also contains interfaces for each of the different types of statistics. The types include count, percentage, time, and other statistical types.

Statistic Enablement

The ObjectGrid can optionally record statistics information for various object instances. Statistics recording can be enabled and disabled using several methods. In all cases, the statistics configuration is performed using a statistics specification string or StatsSpec object, which controls which modules to enable. When running in a WebSphere Application Server environment, ObjectGrid statistics can be enabled using the Performance Monitoring Infrastructure (PMI) service.

Local ObjectGrids

Local ObjectGrids include locally defined ObjectGrids and the local instance of a distributed ObjectGrid, where the local client ObjectGrid is the near cache and the local server ObjectGrid is the ObjectGrid accessed directly within the server process. The statistics specification is modified using the StatsAccessor object.

Dynamic distributed ObjectGrids

ObjectGrid servers can be deployed and managed dynamically. The statistics specification is set using the statsSpec property in the server.properties file.

Static distributed ObjectGrids

ObjectGrid servers can be deployed using a static cluster deployment XML file. The statistics specification is set using the statisticsEnabled and statisticsSpec attributes of the cluster element of the static cluster deployment XML file.

Statistic Retrieval

The ObjectGrid allows retrieving statistics using several different methods depending on the topology in which the ObjectGrid is deployed. All statistics are available using various statistics modules which can be retrieved and introspected using several different methods, depending on the ObjectGrid deployment topology.

Local ObjectGrids

Use the StatsAccessor programming interface to retrieve statistics modules for a locally accessible ObjectGrid.

Dynamic distributed ObjectGrids

When running in a dynamic deployment topology, the server statistic modules can be retrieved using the following methods:

• JMX MBeans: ObjectGridMBean, MapMBean and SessionMBean
• PMI when running in a WebSphere Application Server environment

Static distributed ObjectGrids

When running in a static deployment topology, the server statistic modules can be retrieved using the following methods:

• JMX MBeans: ObjectGridMBean, MapMBean and SessionMBean, StaticServerMBean and ReplicationGroupMemberMBean. MBeans are only available when running the ObjectGrid management gateway service.
• PMI when running in a WebSphere Application Server environment
• Using the ObjectGridAdministrator API.