LATEST VERSION: 8.2.7 - CHANGELOG
Pivotal GemFire® v8.2

JMX Manager MBeans

JMX Manager MBeans

This section describes the MBeans that are available on the JMX Manager node.

The JMX Manager node includes all local beans listed under Managed Node MBeans and the following beans that are available only on the JMX Manager node:

ManagerMXBean

Represents the GemFire Management layer for the hosting member. Controls the scope of management. This MBean provides start and stop methods to turn a managed node into a JMX Manager node or to stop a node from being a JMX Manager. For potential managers (jmx-manager=true and jmx-manager-start=false), this MBean is created when a Locator requests it.

Note: You must configure the node to allow it to become a JMX Manager. See Configuring a JMX Manager for configuration information.
MBean Details
Scope ALL
Proxied No
Object Name GemFire:type=Member, service=Manager,member=<name-or-dist-member-id>
Instances Per Node 1

See the com.gemstone.gemfire.management.ManagerMXBean JavaDocs for information on available MBean methods and attributes.

DistributedSystemMXBean

System-wide aggregate MBean that provides a high-level view of the entire distributed system including all members (cache servers, peers, locators) and their caches. At any given point of time, it can provide a snapshot of the complete distributed system and its operations.

The DistributedSystemMXBean provides APIs for performing distributed system-wide operations such as backing up all members, shutting down all members or showing various distributed system metrics.

You can attach a standard JMX NotificationListener to this MBean to listen for notifications throughout the distributed system. See GemFire JMX MBean Notifications for more information.

This MBean also provides some MBean model navigation APIS. These APIs should be used to navigate through all the MBeans exposed by a GemFire System.

MBean Details
Scope Aggregate
Proxied No
Object Name GemFire:type=Distributed,service=System
Instances Per Node 1

See the com.gemstone.gemfire.management.DistributedSystemMXBean JavaDocs for information on available MBean methods and attributes.

DistributedRegionMXBean

System-wide aggregate MBean of a named region. It provides a high-level view of a region for all members hosting and/or using that region. For example, you can obtain a list of all members that are hosting the region. Some methods are only available for partitioned regions.

MBean Details
Scope Aggregate
Proxied No
Object Name GemFire:type=Distributed,service=Region,name=<regionName>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.DistributedRegionMXBean JavaDocs for information on available MBean methods and attributes.

DistributedLockServiceMXBean

Represents a named instance of DistributedLockService . Any number of DistributedLockService can be created in a member.

A named instance of DistributedLockService defines a space for locking arbitrary names across the distributed system defined by a specified distribution manager. Any number of DistributedLockService instances can be created with different service names. For all processes in the distributed system that have created an instance of DistributedLockService with the same name, no more than one thread is permitted to own the lock on a given name in that instance at any point in time. Additionally, a thread can lock the entire service, preventing any other threads in the system from locking the service or any names in the service.

MBean Details
Scope Aggregate
Proxied No
Object Name GemFire:type=Distributed,service=LockService,name=<dlsName>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.DistributedLockServiceMXBean JavaDocs for information on available MBean methods and attributes.

Managed Node MBeans

This section describes the MBeans that are available on all managed nodes.

JMX Manager nodes will have managed node MBeans for themselves since they are also manageable entities in the distributed system.

MemberMXBean

Member's local view of its connection and cache. It is the primary gateway to manage a particular member. It exposes member level attributes and statistics. Some operations like createCacheServer() and createManager() will help to create some GemFire resources. Any JMX client can connect to the MBean server and start managing a GemFire Member by using this MBean.

See MemberMXBean Notifications for a list of notifications emitted by this MBean.

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,member=<name-or-dist-member-id>
Instances Per Node 1

See the com.gemstone.gemfire.management.MemberMXBean JavaDocs for information on available MBean methods and attributes.

CacheServerMXBean

Represents the GemFire CacheServer. Provides data and notifications about server, subscriptions, durable queues and indices.

See CacheServerMXBean Notifications for a list of notifications emitted by this MBean.

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=CacheServer,member=<name-or-dist-member-id>
Instances Per Node 1

See the com.gemstone.gemfire.management.CacheServerMXBean JavaDocs for information on available MBean methods and attributes.

RegionMXBean

Member's local view of region.

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=Region,name=<regionName>,member=<name-or-dist-member-id>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.RegionMXBean JavaDocs for information on available MBean methods and attributes.

LockServiceMXBean

Represents a named instance of a LockService . Any number of LockServices can be created in a member.

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=LockService,name=<dlsName>,member=<name-or-dist-member-id>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.LockServiceMXBean JavaDocs for information on available MBean methods and attributes.

DiskStoreMXBean

Represents a DiskStore object which provides disk storage for one or more regions

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=DiskStore,name=<name>,member=<name-or-dist-member-id>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.DiskStoreMXBean JavaDocs for information on available MBean methods and attributes.

AsyncEventQueueMXBean

An AsyncEventQueueMXBean provides access to an AsyncEventQueue, which represent the channel over which events are delivered to the AsyncEventListener.

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=AsyncEventQueue=<AsyncEventQueue> ,member=<name-or-dist-member-id>
Instances Per Node 0..N

See the com.gemstone.gemfire.management.AsyncEventQueueMXBean JavaDocs for information on available MBean methods and attributes.

LocatorMXBean

A LocatorMXBean represents a locator .

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=Locator,port=<port>,member=<name-or-dist-member-id>
Instances Per Node 0..1

See the com.gemstone.gemfire.management.LocatorMXBean JavaDocs for information on available MBean methods and attributes.

Managed Node Gateway MBeans

This section describes the MBeans that are available on all managed nodes in multi-site (WAN) deployments.

MBeans that are available on all managed nodes in multi-site (WAN) deployments include:

JMX Manager nodes can also have managed node gateway MBeans for themselves since they are also manageable entities in the distributed system.

GatewayReceiverMXBean

A GatewayReceiverMXBean represents a GatewayReceiver which is a local server for a remote WAN (or distributed system).

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=GatewayReceiver,gatewayReceiver=<gatewayReceiver>,

member=<name-or-dist-member-id>

Instances Per Node 0..N

See the com.gemstone.gemfire.management.GatewayReceiverMXBean JavaDocs for information on available MBean methods and attributes.

GatewaySenderMXBean

A GatewaySenderMBean represents a GatewaySender which is a local proxy for a remote WAN (or distributed system).

MBean Details
Scope Local
Proxied Yes
Object Name GemFire:type=Member,service=GatewaySender,gateSender=<gateSender>, member=<name-or-dist-member-id>
Instances Per Node 0..N