# Package com.gemstone.gbjstats

The gbjstats package provides support for accessing shared page cache statistics.

See: Description

- Class Summary
  Class | Description
  --- | ---
  GbjCacheStats | GbjCacheStats provides an application-friendly level of access to shared page cache statistics.
  GbjHypericPluginGenerator | GbjHypericPluginGenerator generates an XML file that can be used by the VMware Hyperic system monitoring tool to recognize and monitor a GemStone environment that includes a GbxJmxCacheStatsMonitor program.
  GbjJmxCacheStats | GbjJmxCacheStats is a wrapper around GbjCacheStats to allow access to shared page cache statistics through java JMX-based monitoring tools and applications via the DynamicMBean interface.
  GbjJmxCacheStatsMonitor | GbjJmxCacheStatsMonitor is a JMX-compatible application that can be used to monitor and control a GemStone system from a JMX-compatible monitoring tool, such as jconsole or VMware's Hyperic product.
  GbjJmxCommandInfo | Helper class used by GbjJmxSystemStats and GbjHypericPluginGenerator to hold customer-configurable information on valid JMX/Hyperic Commands.
  GbjJmxDataFile | Helper class used by GbjJmxSystemStatInfo and GbjJmxCommandInfo to open and read template data files held in $GBJ/server.
  GbjJmxSystemStatInfo | Helper class used by GbjJmxSystemStats and GbjHypericPluginGenerator to hold customer-configurable information on JMX/Hyperic System Stats.
  GbjJmxSystemStats | GbjJmxSystemStats provides System-level statistics for a GemStone system.

- Enum Summary
  Enum | Description
  --- | ---
  GbjCacheStats.CacheType | A representation for various types of GS processes

## Package com.gemstone.gbjstats Description

The gbjstats package provides support for accessing shared page cache statistics. These statistics can be accessed from a number of sources, including:

- Customer application code using GbjCacheStats,
- Java JMX applications using GbjJmxCacheStats and related support classes and files, and
- VMware's Hyperic monitor using the GbjHypericPluginGenerator and related support files

## Developing Applications using GbjCacheStats

Class GbjCacheStats provides application-level support for accessing GemStone's shared page cache statistics information. Refer to the GbjCacheStats class documentation for details.

Note: Low-level support for accessing shared page cache information is provided through the com.gemstone.gbjgci package and classes GbjGciCacheStats and the GbjGciInterface. Refer to that package documentation for details.

## Java JMX Support

For customers with environments that support Java's framework for application monitoring and mangement (JMX), several classes are provided. These include:

- GbjJmxCacheStats -- an extension of JMX's DynamicMBean that wrappers a GbjCacheStat and provides JMX-level access to its features.
- GbjJmxCacheStatsMonitor -- a JMX-compatible monitoring program that works like statmonitor, but instead of writing a file, formats JMX DynamicMBeans for access through JMX-compliant monitoring applications, such as jconsole.

In addition, there are two template files located in $GBJ/server that can be modified to tailor the information and control provided through a JMX monitoring application. These include:

- GbjJmxSystemStatsTemplate.dat -- specifies a selection of important stone and shpc cache stats to present in a system-level display via JMX.
- GbjJmxCommandsTemplate.dat -- provides a way of executing useful GemStone Smalltalk code for system management through a JMX monitoring application.

Further information on these files can be found in the java documentation for class GbjJmxCacheStatsMonitor.

## Hyperic Monitoring Support

Customers using VMware's Hyperic system monitoring and management tool can also manage GemStone applications through Hyperic. Several items are provided for this:

- Class GbjHypericPluginGenerator -- used to generate the XML plugin file used by Hyperic to access GemStone processes
- File $GBJ/server/GbjHypericServerTemplate.xml and
- File $GBJ/server/GbjHypericServiceTemplate.xml, used by the GbjHypericPluginGenerator to format the resulting XML file.

Hyperic uses special plugin files (either XML files or jar files that contain an XML file) to be able to recognize and manage the various server and service resources that it manages. The GbjHypericPluginGenerator is a java application that can be used to generate this XML file in a form compatible with the customer's environment and configuration. Refer to the class documentation for GbjHypericPluginGenerator for details on how to use the application and its associated Template files.

Version:
  3.1

  Last modified: Tue Jul 14 11:26:40 PDT 2015