This section describes the MBeans that are available on the JMX Manager node.
Represents the GemFire XD management layer for the hosting member. This MBean provides the enableStatementStats method to enable or disable statement- and time-related statistics.
| MBean Details | |
| Scope | Aggregate |
| Proxied | No |
| Object Name | GemFireXD:service=Cluster |
| Instances Per Node | 1 |
| MBean Attributes | |
| Attribute | Description |
| ProcedureCallsCompleted | Gets the aggregated procedures calls completed. |
| ProcedureCallsInProgress | Gets the aggregated procedures calls in progress. |
| NetworkServerClientConnectionStats | Represents aggregation of network server client connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), connections attempted (connectionsAttempted ), Failed connections (connectionsFailed ), connections life time (connectionLifeTime), open connections (connectionsOpen) and idle connections (connectionsIdle). |
| NetworkServerPeerConnectionStats | Represents aggregation of network server peer connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), connections attempted (connectionsAttempted ), Failed connections (connectionsFailed ), connections life time (connectionLifeTime), open connections (connectionsOpen) and idle connections (connectionsIdle). |
| NetworkServerInternalConnectionStats | Represents aggregation of network server internal connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), open connections (connectionsOpen). |
| NetworkServerNestedConnectionStats | Represents aggregation of network server nested connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), open connections (connectionsOpen). |
| Members | Retrieves member ids. |
| MBean Operations | |
| Operation | Description |
| EnableStatementStats | Enables or disables stats. The first parameter enables/disables stats and second one enables/disables Time stats. |
System-wide aggregate MBean that provides a high-level view of the statements for all members in the distributed system. This bean provides metrics for individual statements.
| MBean Details | |
| Scope | Aggregate |
| Proxied | No |
| Object Name | GemFireXD: service=Statement,type=Aggregate,name={StatementID} |
| Instances Per Node | 0..N |
| MBean Attributes | |
| Attribute | Description |
| NumTimesCompiled | The number of times this statement was compiled (including recompilations) during the sampling interval. |
| NumExecution | The number of times this statement was executed between the sampling interval. |
| NumExecutionsInProgress | The number of statements that are actively being processed during the statistics snapshot of the sampling interval. |
| NumTimesGlobalIndexLookup | The number of times global index lookup message exchanges occurred during the sampling interval. |
| NumRowsModified | The number of rows modified by DML operations (insert/delete/update) during the sampling interval. |
| ParseTime | The time spent (in milliseconds) parsing the query string during the sampling interval. |
| BindTime | The time spent (in milliseconds) mapping the statement with the database object's metadata (binding) during the sampling interval. |
| OptimizeTime | The time spent (in milliseconds) determining the best execution path for this statement (optimizing) during the sampling interval. |
| RoutingInfoTime | The time spent (in milliseconds) compiling details about routing information of query strings to data node(s) (processQueryInfo) during the sampling interval. |
| GenerateTime | The time spent (in milliseconds) generating query execution plan definitions (activation class) during the sampling interval. |
| TotalCompilationTime | The total compilation time (in milliseconds) of the statement on this node (prepMinion) during the sampling interval. |
| ExecutionTime | The time spent (in nanoseconds) creating all the layers of query processing (ac.execute) during the sampling interval. |
| ProjectionTime | The time (in nanoseconds) to apply the projection and additional filters during the sampling interval. |
| TotalExecutionTime | The total execution time (in nanoseconds) taken to process the statement on this node (execute/open/next/close) during the sampling interval. |
| RowsModificationTime | The time taken (in nanoseconds) to modify rows by DML operation (insert/delete/update) during the sampling interval. |
| QNNumRowsSeen | The number of rows returned from remote nodes (ResultHolder/Get convertibles) during the sampling interval. |
| QNMsgSendTime | The TCP send time (in nanoseconds) of all the messages including serialization time and queue wait time during the sampling interval. |
| QNMsgSerTime | The serialization time (in nanoseconds) for all the messages while sending to remote node(s) during the sampling interval. |
| QNRespDeSerTime | The response message deserialization time (in nanoseconds) from remote node(s) excluding resultset deserialization during the sampling interval. |
System-wide aggregate MBean that provides a high-level view of the tables for all members in the that host the MBean.
| MBean Details | |
| Scope | Aggregate |
| Proxied | No |
| Object Name | GemFireXD: service=Table,type=Aggregate,table={TableName} |
| Instances Per Node | 0..N |
| MBean Attributes | |
| Attribute | Description |
| EntrySize | The entry overhead, in kilobytes. This only reflects the amount of memory required to hold the table row in memory, but does not include the memory required to hold its key and value |
| NumberOfRows | The number of rows in a table |
Represents the GemFire XD 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.
| 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.
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 XD 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 XD 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.
System-wide aggregate MBean of a named table. It provides a high-level view of a table for all members hosting and/or using that table. For example, you can obtain a list of all members that are hosting the table. Some methods are only available for partitioned table.
| 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.
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=Region,name=<regionName> |
| Instances Per Node | 0..N |
See the com.gemstone.gemfire.management.DistributedLockServiceMXBean JavaDocs for information on available MBean methods and attributes.
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.
Provides the 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 and provides operations such as fetchMetaData(), fetchEvictionPercent(), updateEvictionPercent(), fetchCriticalPercent(), updateCriticalPercent(), detectDeadLocks(), GetStack(), and ActiveThread().
| MBean Details | |
| Scope | Local |
| Proxied | Yes |
| Object Name | GemFireXD:group={GroupName},type=Member,member={memberName} |
| Instances Per Node | 1 |
| MBean Attributes | |
| Attribute | Description |
| Name | Name of the member |
| Id | Id of the member |
| Groups | Server groups associated with member |
| NetworkServerClientConnectionStats | Represents network server client connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), connections attempted (connectionsAttempted ), Failed connections (connectionsFailed ), connections life time (connectionLifeTime), open connections (connectionsOpen), and idle connections (connectionsIdle). |
| NetworkServerPeerConnectionStats | Represents network server peer connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), connections attempted (connectionsAttempted ), Failed connections (connectionsFailed ), connections life time (connectionLifeTime), open connections (connectionsOpen), and idle connections (connectionsIdle). |
| NetworkServerNestedConnectionStats | Represents network server nested connection stats. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), open connections (connectionsOpen). |
| NetworkServerInternalConnectionStats | Represents network server internal connection stats i.e. the connections which GemFire XD opens internally. It has attributes e.g. connection type (connectionStatsType), opened connections (connectionsOpened), closed connections (connectionsClosed), and open connections (connectionsOpen). |
| ProcedureCallsCompleted | Procedure calls completed for a member. |
| ProcedureCallsInProgress | Procedure call in progress for a member. |
| DataStore | True if member is a data store. |
| Locator | True if member is locator. |
| MBean Operations | |
| Operation | Description |
| FetchMetadata | Retrieves meta data of a member e.g. "id", "kind", "status", "hostData", "isElder", "ipAddress", "host", "pid", "port", "roles", "netservers", "locator", "serverGroups", "managerInfo", "systemProps", "gemFireProps", "bootProps". |
| FetchEvictionPercent | Gets eviction percentage i.e. percentage of heap space that triggers members of one or more GemFire XD server groups to perform LRU eviction on tables that are configured for eviction. |
| UpdateEvictionPercent | Sets eviction percentage i.e. percentage of heap space that triggers members of one or more GemFire XD server groups to perform LRU eviction on tables that are configured for eviction. |
| FetchCriticalPercent | Gets critical percentage which is intended to allow the eviction and GC work to catch up. |
| UpdateCriticalPercent | Sets critical percentage which is intended to allow the eviction and GC work to catch up. |
| DetectDeadlocks | Identifies deadlocks in a member. |
| GetStack | Retrieves stack for the specified thread or if nothing is specified then for all threads. |
| ActiveThread | For active threads, retrieves thread name and thread ID. |
Represents a GemFire XD statement. It provides statement statistics and the retrieveString() operation.
| MBean Details | |
| Scope | Local |
| Proxied | Yes |
| Object Name | GemFireXD:service=Statement,type=Member,member={memberID},name={statementID} |
| Instances Per Node | 0..N |
| MBean Attributes | |
| Attribute | Description |
| QNNumTimesCompiled | For query node, Number of times this statement is compiled (including recompilations). |
| QNNumExecutions | For query node, Number of times this statement is executed. |
| QNNumExecutionsInProgress | For query node, Statements that are actively being processed. |
| QNNumTimesGlobalIndexLookup | For query node, Number of times global index lookup message exchanges occurred. |
| QNNumRowsModified | For query node, Number of rows modified by DML operation of insert/delete/update. |
| QNParseTime | For query node, Time spent(in milliseconds) in parsing the query string. |
| QNBindTime | For query node, Time spent (in milliseconds) mapping this statement with database object's metadata (bind). |
| QNOptimizeTime | For query node, Time spent (in milliseconds) determining the best execution path for this statement (optimize). |
| QNRoutingInfoTime | For query node, Time spent (in milliseconds) compiling details about routing information of query strings to data node(s). |
| QNGenerateTime | For query node, Time spent (in milliseconds) to generate query execution plan definition (activation class). |
| QNTotalCompilationTime | For query node, Total compilation time (in milliseconds) of the statement on this node. |
| QNExecuteTime | For query node, Time spent (in nanoseconds) in creation of all the layers of query processing. |
| QNProjectionTime | For query node, Time to apply (in nanoseconds) the projection and additional filters. |
| QNTotalExecutionTime | For query node, Total execution time (in nanoseconds) taken to process the statement on this node (execute/open/next/close). |
| QNRowsModificationTime | For query node, Time taken (in nanoseconds) to modify rows by DML operation of insert/delete/update. |
| NumProjectedRows | Number of rows returned after applying projection at different stages of processing rowcounts. |
| NumNLJoinRowsReturned | Number of rows output by nested loop joins of the query. |
| NumHASHJoinRowsReturned | Number of rows output by nested loop joins of the query. |
| NumTableRowsScanned | Number of rows returned from all the involved table scans. |
| NumRowsHashScanned | Number of rows returned from a hash scan or distinct scan. |
| NumIndexRowsScanned | Number of rows returned from all the involved index scans. |
| NumRowsSorted | Number of rows that is sorted due to group by/order by clauses. |
| NumSortRowsOverflowed | Number of rows overflowed to temporary files due to sorting. |
| NumSingleHopExecutions | Number of times the prepared statement executed locally due to single hop. |
| SubQueryNumRowsSeen | Number of rows seen while subquery execution (by parent query). |
| MsgDeSerTime | Message deserialization time, in nanoseconds, including parameters but excluding MsgProcessTime. |
| MsgProcessTime | Message process time, in nanoseconds, including local data set creation, query execute and response sending time. |
| ResultIterationTime | Time, in nanoseconds, to iterate through determined set of results on this node. |
| RespSerTime | Response, in nanoseconds, message serialization time excluding ResultIterationTime. |
| ThrottleTime | Response, in nanoseconds, throttle wait time on data node. |
| NLJoinTime | Time, in nanoseconds, to process all the nested loop join relations of the query. |
| HASHJoinTime | Time, in nanoseconds, to process all the hash join relations of the query. |
| TableScanTime | Time, in nanoseconds, taken to scan all the tables involved in the query. |
| HashScanTime | Time, in nanoseconds, taken to build a hash table for distinct evaluation or other optimization purpose. |
| IndexScanTime | Time, in nanoseconds, taken to scan all the indexes involved in the query. |
| SortTime | Time, in nanoseconds, taken to sort rows while applying group by or order by clause. |
| SubQueryExecutionTime | Time, in nanoseconds, taken to scan rows from Subquery (by parent query). |
| DNNumTimesCompiled | For data node, Number of times this statement is compiled (including recompilations). |
| DNNumExecution | For data node, Number of times this statement is executed. |
| DNNumExecutionsInProgress | For data node, Statements that are actively being processed. |
| DNNumTimesGlobalIndexLookup | For data node, Number of times global index lookup message exchanges occurred. |
| DNNumRowsModified | For data node, Number of rows modified by DML operation of insert/delete/update. |
| DNParseTime | For data node, Time spent(in milliseconds) in parsing the query string. |
| DNBindTime | For data node, Time spent (in milliseconds) applying this statement with database object's metadata (bind). |
| DNOptimizeTime | For data node, Time spent (in milliseconds) determining the best execution path for this statement (optimize). |
| DNRoutingInfoTime | For data node, Time spent (in milliseconds) compiling details about routing information of query strings to data node(s). |
| DNGenerateTime | For data node, Time spent (in milliseconds) to generate query execution plan definition. |
| DNTotalCompilationTime | For data node, Total compilation time (in milliseconds) of the statement on this node. |
| DNExecutionTime | For data node, Time spent (in nanoseconds) in creation of all the layers of query processing. |
| DNProjectionTime | For data node, Time to apply (in nanoseconds) the projection and additional filters. |
| DNTotalExecutionTime | For data node, Total execution time (in nanoseconds) taken to process the statement on this node (execute/open/next/close). |
| DNRowsModificationTime | For data node, Time taken (in nanoseconds) to modify rows by DML operation of insert/delete/update. |
| QNNumRowsSeen | For query node, Number of rows returned from remote nodes (ResultHolder/Get convertibles). |
| QNMsgSendTime | For query node, TCP send time (in nanoseconds) of all the messages including serialization time and queue wait time. |
| QNMsgSerTime | For query node, Serialization time (in nanoseconds) for all the messages while sending to remote node(s). |
| QNRespDeSerTime | For query node, Response message deserialization time (in nano seconds ) from remote node(s) excluding resultset deserialization. |
| MBean Operations | |
| Operation | Description |
| RetrievString | Gets the statement for that MBean. |
Represents a table's local view. This MBean provides statement statistics and operations such as fetchMetaData(), listIndexInfo(), and showEvictionAttributes().
| MBean Details | |
| Scope | Local |
| Proxied | Yes |
| Object Name | GemFireXD:group={groupName},service=Table,type=Member,member={memberName},table={tableName} |
| Instances Per Node | 0..N |
| MBean Attributes | |
| Attribute | Description |
| Name | Name of the table. |
| ParentSchema | Parent schema of the table. |
| ServerGroups | Server groups associated with table. |
| Definition | Table schema definition. |
| Policy | Data policy. |
| PartitioningScheme | Partition details. |
| Inserts | Number of inserts for table. |
| Deletes | Number of deletes for table. |
| Updates | Number of updates for table. |
| EntrySize | Entry overhead, in kilobytes. Only reflects the amount of memory required to hold the table row in memory but not including the memory to hold its key and value. |
| KeySize | Key size for a table. |
| NumberOfRows | Number of rows in a table. |
| MBean Operations | |
| Operation | Description |
| FetchMetadata() | Table information e.g. Table Id, Table Name, table type, schema id, table schema name, lock granularity,server groups, data policy, partition attributes, resolver, expiration attributes, eviction attributes, disk attributes, loader, writer, listners, asynchronous listeners, Gateway enabled/disabled, gateway senders, and so forth. |
| ShowEvictionAttributes() | Details of eviction policy e.g. Algorithm used for eviction, Maximum entries in table before eviction starts and Action to be taken if entries reaches maximum value. |
| ListIndexInfo() | Index details e.g. index name, index type, entry size, key size and row count. |
| 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.
Member's local view of table.
| 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.
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.
Represents a DiskStore object which provides disk storage for one or more tables
| 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.
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.
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 |
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.
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.