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 {@link org.apache.geode.admin.AdminDistributedSystemFactory} is the starting point. It creates an instance of AdminDistributedSystem that administers the distributed system to which a VM is {@linkplain org.apache.geode.distributed.DistributedSystem connected}.


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

This {@link org.apache.geode.admin.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 {@link org.apache.geode.admin.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 {@link org.apache.geode.cache.Cache cache} instances. There are three levels of health: {@linkplain org.apache.geode.admin.GemFireHealth#GOOD_HEALTH good health} that indicates that all GemFire components are behaving reasonably, {@linkplain org.apache.geode.admin.GemFireHealth#OKAY_HEALTH okay health} that indicates that one or more GemFire components is slightly unhealthy and may need some attention, and {@linkplain org.apache.geode.admin.GemFireHealth#POOR_HEALTH 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. {@link org.apache.geode.admin.GemFireHealthConfig} provides methods for configuring how the health of {@linkplain org.apache.geode.admin.DistributedSystemHealthConfig the distributed system}, {@linkplain org.apache.geode.admin.CacheHealthConfig members that host Cache instances}, and {@linkplain org.apache.geode.admin.MemberHealthConfig individual members} of the distributed system. GemFireHealthConfig also allows you to configure how often GemFire's health is evaluated.