GemFire 5.8

Package com.gemstone.gemfire.admin

Provides an API for administering various GemFire components such as a GemFire distributed system, and processes that host GemFire Caches.

See:
          Description

Interface Summary
AdminDistributedSystem Administrative interface for managing an entire GemFire distributed system.
Alert An administration alert that is issued by a member of a GemFire distributed system.
AlertListener A listener whose callback methods are invoked when an Alert is received.
CacheHealthConfig Provides configuration information relating to the health of a member of a GemFire distributed system that hosts a GemFire Cache.
CacheServer Deprecated. as of 5.7 use CacheVm instead.
CacheServerConfig Deprecated. as of 5.7 use CacheVmConfig instead.
CacheVm A dedicated cache server VM that is managed by the administration API.
CacheVmConfig Configuration for a GemFire cache server VM that is managed by the administration API.
ConfigurationParameter A single configuration parameter of a SystemMember.
DistributedSystemConfig Configuration for defining a GemFire distributed system to administrate.
DistributedSystemConfig.ConfigListener A listener whose callback methods are invoked when this config changes.
DistributedSystemHealthConfig Provides configuration information relating to the health of an entire GemFire distributed system.
DistributionLocator Represents a single distribution locator server, of which a distributed system may use zero or many.
DistributionLocatorConfig Describes the configuration of a DistributionLocator managed by the GemFire administration APIs.
GemFireHealth Provides information about the aggregate health of the members of a GemFire distributed system ("components").
GemFireHealthConfig Provides configuration information relating to all of the components of a GemFire distributed system.
ManagedEntity A entity that can be managed with the GemFire administration API.
ManagedEntityConfig Common configuration for all entities that can be managed using the GemFire administration API.
MemberHealthConfig Provides configuration information relating to the health of a member of a GemFire distributed system.
Statistic Interface to represent a single statistic of a StatisticResource
StatisticResource Adminitrative interface for monitoring a statistic resource in a GemFire system member.
SystemMember Administrative interface for monitoring a GemFire system member.
SystemMemberBridgeServer Deprecated. as of 5.7 use SystemMemberCacheServer instead.
SystemMemberCache Administrative interface that represent's the SystemMember's view of its Cache.
SystemMemberCacheEvent An event that describes an operation on a cache.
SystemMemberCacheListener A listener whose callback methods can be used to track the lifecycle of caches and regions in the GemFire distributed system.
SystemMemberCacheServer Administrative interface that represents a CacheServer that serves the contents of a system member's cache to clients.
SystemMemberRegion Administrative interface that represent's the SystemMember's view of one of its cache's Regions.
SystemMemberRegionEvent An event that describes an operation on a region.
SystemMembershipEvent An event that describes the distributed member originated this event.
SystemMembershipListener A listener whose callback methods are invoked when members join or leave the GemFire distributed system.
 

Class Summary
AdminConfig AdminConfig loads/stores the member information list.
AdminConfig.Entry  
AdminDistributedSystemFactory Factory for creating GemFire administration entities.
AlertLevel Type-safe enumeration for Alert level.
GemFireHealth.Health An enumerated type for the health of GemFire.
GemFireMemberStatus Class GemFireMemberStatus provides the status of a specific GemFire member VM.
RegionSubRegionSnapshot Class RegionSubRegionSnapshot provides information about Regions.
SystemMemberType Type-safe definition for system members.
 

Exception Summary
AdminException An AdminException is thrown when administration or monitoring of GemFire fails.
AdminXmlException Thrown when a problem is encountered while working with admin-related XML data.
CacheDoesNotExistException An CacheDoesNotExistException is thrown when an attempt is made to get a cache and one does not exist.
OperationCancelledException Thrown when an administration operation that accesses information in a remote system member is cancelled.
RegionNotFoundException Thrown by the administration API when the region administered by a SystemMemberRegion has been closed or destroyed in system member.
RuntimeAdminException A RuntimeAdminException is thrown when a runtime errors occurs during administration or monitoring of GemFire.
UnmodifiableConfigurationException An UnmodifiableConfigurationException is thrown when an attempt is made to modify the value of an unmodifiable ConfigurationParameter.
 

Package com.gemstone.gemfire.admin Description

Provides an API for administering various GemFire components such as a GemFire distributed system, and processes that host GemFire Caches.

Administration of a GemFire Distributed System

The Admin API provides interfaces for administrative control, monitoring, and custom management of a GemFire system.

The AdminDistributedSystemFactory is the starting point. It creates an instance of AdminDistributedSystem that administers the distributed system to which a VM is connected.


DistributedSystem connection = DistributedSystem.connect(new Properties());
AdminDistributedSystem system = 
    AdminDistributedSystemFactory.getDistributedSystem(connection);
system.connect(new File("admin.log"), "info");

This AdminDistributedSystem interface exposes methods for such tasks as connecting to the system, merging system logs, getting administrative interfaces to applications that host GemFire Caches.

Monitoring the Health of GemFire

The GemFireHealth interface allows the overall health of GemFire to be monitored. GemFireHealth monitors the behavior the members of a distributed system namely application VMs that may host cache instances. There are three levels of health: good health that indicates that all GemFire components are behaving reasonably, okay health that indicates that one or more GemFire components is slightly unhealthy and may need some attention, and poor health that indicates that a GemFire component is unhealthy and needs immediate attention.

Because each GemFire application has its own definition of what it means to be "healthy", the metrics that are used to determine health are configurable. GemFireHealthConfig provides methods for configuring how the health of the distributed system, members that host Cache instances, and individual members of the distributed system. GemFireHealthConfig also allows you to configure how often GemFire's health is evaluated.


GemFire 5.8

Copyright © 2002-2008 GemStone Systems, Inc. All Rights Reserved.