E Coherence MBeans Reference

This appendix provides a reference of the Coherence MBeans that are used to manage and monitor different parts of Coherence. All of the MBeans' attributes and operations are described in detail.

In addition to this reference, Coherence MBeans are described in the Registration interface, see Oracle Coherence Java API Reference. An MBean-capable agent (such as JConsole) can also be used to view MBean information. See Part VI, "Managing Coherence" for more information on using the management features of Coherence.

The following sections are included in this Appendix:

Overview
MBean Index
CacheMBean
ClusterMBean
ClusterNodeMBean
ConnectionManagerMBean
ConnectionMBean
ManagementMBean
PointToPointMBean
ReporterMBean
ServiceMBean
StorageManagerMBean
TransactionManagerMBean

Overview

The Coherence cluster management gateway uses a Registration interface that is specific to managing Coherence clustered resources and is an abstraction of the basic JMX registration APIs. Though the interface is closely related to the JMX infrastructure, it is independent from javax.management.* classes. This enables remote management support for cluster nodes that are not co-located with any JMX services. In addition, the Coherence MBeans are registered in an MBean server that could either be co-located or remote in relation to the managed object.

MBean Index

Table E-1 lists the MBeans that are provided for managing Coherence.

Table E-1 Coherence MBeans

MBean	Description
`CacheMBean`	Represents a cache. A cluster node may have zero or more instances of this managed bean.
`ClusterMBean`	Represents a cluster object. Each cluster node has a single instance of this managed bean.
`ClusterNodeMBean`	Represents a cluster member. Each cluster node has a single instance of this managed bean.
`ConnectionManagerMBean`	Represents a Coherence*Extend proxy. A cluster node may have zero or more instances of this managed bean.
`ConnectionMBean`	Represents a remote client connection through Coherence*Extend. A cluster node may have zero or more instances of this managed bean.
`ManagementMBean`	Represents the grid JMX infrastructure. Each cluster node has a single instance of this managed bean.
`PointToPointMBean`	Represents the network status between two cluster members. Each cluster node has a single instance of this managed bean.
`ReporterMBean`	Represents the Coherence JMX Reporter. Each cluster node has a single instance of this managed bean.
`ServiceMBean`	Represents a clustered Service. A cluster node may have zero or more instances of this managed bean.
`StorageManagerMBean`	Represents a storage instance for a storage-enabled distributed cache service. A cluster node may have zero or more instances of this managed bean.
`TransactionManagerMBean`	Represents a transaction manager. A cluster node may have zero or more instances of this managed bean.

CacheMBean

The CacheMBean MBean represents a cache. A cluster node may have zero or more instances of this managed bean depending on the number of caches that are configured for each data service type (distributed, replicated, and so on). This MBean provides operational and performance statistics for a cache. Some of the MBean's attributes are writable and allow the behavior of a cache to be changed in real time.

The MBean's object name is:

type=Cache,service=service name,name=cache name,nodeId=cluster node's id,tier=tier tag

Note:

The CacheMBean MBean contains many attributes that are not applicable to transactional caches. A transactional cache returns a -1 value if the non-applicable attributes are invoked. See "CacheMBeans for Transactional Caches" for a list of the supported attributes and transaction-specific descriptions.

Attributes

Table E-2 describes the attributes for CacheMBean.

Table E-2 CacheMBean Attributes

Attribute	Type	Access	Description
`AverageGetMillis`	`Double`	RO	The average number of milliseconds per `get()` invocation since the last time statistics were reset.
`AverageHitMillis`	`Double`	RO	The average number of milliseconds per `get()` invocation that is a hit.
`AverageMissMillis`	`Double`	RO	The average number of milliseconds per `get()` invocation that is a miss.
`AveragePutMillis`	`Double`	RO	The average number of milliseconds per put() invocation since the cache statistics were last reset.
`BatchFactor`	`Double`	RW	The BatchFactor attribute is used to calculate the soft-ripe time for write-behind queue entries. A queue entry is considered to be ripe for a write operation if it has been in the write-behind queue for no less than the `QueueDelay` interval. The soft-ripe time is the point in time prior to the actual ripe time after which an entry is included in a batch asynchronous write operation to the cache store (along with all other ripe and soft-ripe entries). This attribute is only applicable if asynchronous writes are enabled (that is, the value of the `QueueDelay` attribute is greater than zero) and the cache store implements the `storeAll()` method. The value of the element is expressed as a percentage of the `QueueDelay` interval. Valid values are doubles in the interval [0.0, 1.0].
`CacheHits`	`Long`	RO	The rough number of cache hits since the last time statistics were reset. A cache hit is a read operation invocation (that is, `get()`) for which an entry exists in this map.
`CacheHitsMillis`	`Long`	RO	The total number of milliseconds (since the last time statistics were reset) for the `get()` operations for which an entry existed in this map.
`CacheMisses`	`Long`	RO	The rough number of cache misses since the last time statistics were reset.
`CacheMissesMillis`	`Long`	RO	The total number of milliseconds (since the last time statistics were reset) for the `get()` operations for which no entry existed in this map.
`CachePrunes`	`Long`	RO	The number of prune operations since the last time statistics were reset. A prune operation occurs every time the cache reaches its high watermark as specified by the `HighUnits` attribute.
`CachePrunesMillis`	`Long`	RO	The total number of milliseconds for the prune operations since the last time statistics were reset.
`Description`	`String`	RO	The cache description.
`ExpiryDelay`	`Integer`	RW	The time-to-live for cache entries in milliseconds. Value of zero indicates that the automatic expiry is disabled. Change of this attribute will not affect already-scheduled expiry of existing entries.
`HighUnits`	`Integer`	RW	The limit of the cache size measured in units. The cache will prune itself automatically once it reaches its maximum unit level. This is often referred to as the high water mark of the cache.
`HitProbability`	`Double`	RO	The rough probability (`0 <= p <= 1`) that the next invocation will be a hit, based on the statistics collected since the last time statistics were reset.
`LowUnits`	`Integer`	RW	The number of units to which the cache will shrink when it prunes. This is often referred to as a low water mark of the cache.
`PersistenceType`	`String`	RO	The persistence type for this cache. Possible values include: `NONE`, `READ-ONLY`, `WRITE-THROUGH`, `WRITE-BEHIND`.
`QueueDelay`	`Integer`	RW	The number of seconds that an entry added to a write-behind queue sits in the queue before being stored using a cache store. This attribute is only applicable if the persistence type is `WRITE-BEHIND`.
`QueueSize`	`Integer`	RO	The size of the write-behind queue size. This attribute is only applicable if the persistence type is `WRITE-BEHIND`.
`RefreshFactor`	`Double`	RW	This attribute is used to calculate the soft-expiration time for cache entries. Soft-expiration is the point in time prior to the actual expiration after which any access request for an entry will schedule an asynchronous load request for the entry. This attribute is only applicable for a read write backing map which has an internal local cache with scheduled automatic expiration. The value of this element is expressed as a percentage of the internal local cache expiration interval. Valid values are doubles in the interval [0.0, 1.0]. If zero, refresh-ahead scheduling is disabled.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`RequeueThreshold`	`Integer`	RW	The maximum size of the write-behind queue for which failed cache store write operations are requeued. If zero, the write-behind requeueing will be disabled. This attribute is only applicable if the persistence type is `WRITE-BEHIND`.
`Size`	`Integer`	RO	The number of entries in the cache.
`StoreAverageBatchSize`	`Long`	RO	The average number of entries stored for each cache store write operation. A call to the `store()` method is counted as a batch of one, whereas a call to the `storeAll()` method is counted as a batch of the passed Map size. The value is `-1` if the persistence type is `NONE`.
`StoreAverageReadMillis`	`Long`	RO	The average time (in milliseconds) spent per read operation. The value is `-1` if the persistence type is `NONE`.
`StoreAverageWriteMillis`	`Long`	RO	The average time (in milliseconds) spent per write operation. The value is `-1` if the persistence type is `NONE`.
`StoreFailures`	`Long`	RO	The total number of cache store failures (load, store and erase operations). The value is `-1` if the persistence type is `NONE.`
`StoreReadMillis`	`Long`	RO	The cumulative time (in milliseconds) spent on load operations. The value is `-1` if the persistence type is `NONE`.
`StoreReads`	`Long`	RO	The total number of load operations. The value is `-1` if the persistence type is `NONE`.
`StoreWriteMillis`	`Long`	RO	The cumulative time (in milliseconds) spent on store and erase operations. The value is `-1` if the persistence type is `NONE` or `READ-ONLY`.
`StoreWrites`	`Long`	RO	The total number of store and erase operations. The value is `-1` if the persistence type is `NONE` or `READ-ONLY`.
`TotalGets`	`Long`	RO	The total number of `get()` operations since the last time statistics were reset.
`TotalGetsMillis`	`Long`	RO	The total number of milliseconds spent on `get()` operations since the last time statistics were reset.
`TotalPuts`	`Long`	RO	The total number of `put()` operations since the last time statistics were reset.
`TotalPutsMillis`	`Long`	RO	The total number of milliseconds spent on `put()` operations since the last time statistics were reset.
`UnitFactor`	`Integer`	RO	The factor by which the `Units`, `LowUnits` and `HighUnits` properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.
`Units`	`Integer`	RO	The size of the cache measured in units. This value needs to be adjusted by the `UnitFactor`.

Operations

The CacheMBean MBean includes a resetStatistics operation that resets all cache statistics.

ClusterMBean

The ClusterMBean MBean represents a cluster. Each cluster node has a single instance of this managed bean. This MBean provides operational statistics about the cluster.

The MBean's object name is:

type=Cluster

Attributes

Table E-3 describes the attributes for ClusterMBean.

Table E-3 ClusterMBean Attributes

Attribute	Type	Access	Description
`ClusterName`	`String`	RO	The name of the cluster.
`ClusterSize`	`Integer`	RO	The total number of cluster nodes.
`LicenseMode`	`String`	RO	The license mode that this cluster is using. Possible values are `Evaluation`, `Development` or `Production`.
`LocalMemberId`	`Integer`	RO	The member id for the cluster member that is co-located with the reporting MBean server. The value is `-1` if the cluster service is not running.
`MemberIds`	`Integer[]`	RO	An array of all existing cluster member ids.
`Members`	`String[]`	RO	An array of all existing cluster members.
`MembersDeparted`	`String[]`	RO	An array of strings containing the member information for recently departed cluster members. Members are removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBean server node leaves and rejoins the cluster. The `MembersDepartureCount` is the total count of departed members and not the size of this array.
`MembersDepartureCount`	`Long`	RO	The number of times this node has observed another node`s departure from the cluster since this management node has joined the cluster or statistics have been reset.
`OldestMemberId`	`Integer`	RO	The senior cluster member id. The value is `-1` if the cluster service is not running.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`Running`	`Boolean`	RO	Specifies whether or not the cluster is running.
`Version`	`String`	RO	The Coherence version.

Operations

Table E-4 describes the operations for ClusterMBean.

Table E-4 ClusterMBean Operations

Operation	Parameters	Return Type	Description
`ensureRunning`	`Void`	`Void`	Ensures that the cluster service is running on this node.
`shutdown`	`Void`	`Void`	Shuts down the cluster service on this node.

ClusterNodeMBean

The ClusterNodeMBean MBean represents a cluster member. Each cluster node has a single instance of this managed bean. This MBean provides many operational and performance statistics for a node/member of a cluster. Many of the attributes are writable and allow the behavior of the node to be changed in real time.

The MBean's object name is:

type=Node,nodeId=cluster node's id

Attributes

Table E-5 describes the attributes for ClusterNodeMBean.

Table E-5 ClusterNodeMBean Attributes

Attribute	Type	Access	Description
`BufferPublishSize`	`Integer`	RW	The buffer size of the unicast datagram socket used by the Publisher, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
`BufferReceiveSize`	`Integer`	RW	The buffer size of the unicast datagram socket used by the Receiver, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
`CpuCount`	`Integer`	RO	Number of CPU cores for the machine this member is running on.
`FlowControlEnabled`	`Boolean`	RO	Indicates whether or not `FlowControl` is enabled. See "flow-control".
`Id`	`Integer`	RO	The short member id that uniquely identifies the member at this point in time and does not change for the life of this member.
`LoggingDestination`	`String`	RO	The output device used by the logging system. Valid values are `stdout`, `stderr`, `jdk`, `log4j`, or a file name.
`LoggingFormat`	`String`	RW	Specifies how messages will be formatted before being passed to the log destination.
`LoggingLevel`	`Integer`	RW	Specifies which logged messages will be output to the log destination. Valid values are non-negative integers. A value of `-1` to disable all logger output.
`LoggingLimit`	`Integer`	RW	The maximum number of characters that the logger daemon will process from the message queue before discarding all remaining messages in the queue. Valid values are positive integers in the range `0` to `Integer.MAX_VALUE` (2147483647). Zero implies `Integer.MAX_VALUE`.
`MachineId`	`Integer`	RO	The member`s machine Id.
`MachineName`	`String`	RO	A configured name that should be the same for all members that are on the same physical machine, and different for members that are on different physical machines.
`MemberName`	`String`	RO	A configured name that must be unique for every member.
`MemoryAvailableMB`	`Integer`	RO	The total amount of memory in the JVM available for new objects in MB.
`MemoryMaxMB`	`Integer`	RO	The maximum amount of memory that the JVM will attempt to use in MB.
`MulticastAddress`	`String`	RO	The IP address of the member`s multicast socket for group communication.
`MulticastEnabled`	`Boolean`	RO	Specifies whether or not this member uses multicast for group communication. If `false`, this member will use the addresses listed in the `WellKnownAddresses` attribute to join the cluster and point-to-point unicast to communicate with other members of the cluster.
`MulticastPort`	`Integer`	RO	The port of the member`s multicast socket for group communication.
`MulticastTTL`	`Integer`	RO	The time-to-live for multicast packets sent out on this member`s multicast socket.
`MulticastThreshold`	`Integer`	RW	The percentage (0 to 100) of the servers in the cluster that a packet will be sent to, above which the packet is sent using multicast and below which it is sent using unicast.
`NackEnabled`	`Boolean`	RO	Indicates whether or not the early packet loss detection protocol is enabled.
`NackSent`	`Long`	RO	The total number of NACK packets sent since the node statistics were last reset.
`PacketDeliveryEfficiency`	`Float`	RO	The efficiency of packet loss detection and retransmission. A low efficiency is an indication that there is a high rate of unnecessary packet retransmissions.
`PacketsBundled`	`Long`	RO	The total number of packets which were bundled prior to transmission. The total number of network transmissions is equal to `PacketsSent - PacketsBundled`.
`PacketsReceived`	`Long`	RO	The number of packets received since the node statistics were last reset.
`PacketsRepeated`	`Long`	RO	The number of duplicate packets received since the node statistics were last reset.
`PacketsResent`	`Long`	RO	The number of packets resent since the node statistics were last reset. A packet is resent when there is no ACK received within a timeout period.
`PacketsResentEarly`	`Long`	RO	The total number of packets resent ahead of schedule. A packet is resent ahead of schedule when there is a NACK indicating that the packet has not been received.
`PacketsResentExcess`	`Long`	RO	The total number of packet retransmissions which were later proven unnecessary.
`PacketsSent`	`Long`	RO	The number of packets sent since the node statistics were last reset.
`Priority`	`Integer`	RO	The priority, or weight, of the member; used to determine tie-breakers.
`ProcessName`	`String`	RO	A configured name that should be the same for members that are in the same process (JVM), and different for members that are in different processes. If not explicitly provided, the name will be calculated internally as the `Name` attribute of the system `RuntimeMXBean`, which normally represents the process identifier (PID).
`ProductEdition`	`String`	RO	The product edition this member is running. Possible values are: `Standard Edition`, `Enterprise Edition`, `Grid Edition`.
`PublisherPacketUtilization`	`Float`	RO	The publisher packet utilization for this cluster node since the node socket was last reopened. This value is a ratio of the number of bytes sent to the number that would have been sent had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
`PublisherSuccessRate`	`Float`	RO	The publisher success rate for this cluster node since the node statistics were last reset. The publisher success rate is a ratio of the number of packets successfully delivered in a first attempt to the total number of sent packets. A failure count is incremented when there is no ACK received within a timeout period. It could be caused by either very high network latency or a high packet drop rate.
`QuorumStatus`	`String`	RO	The current state of the cluster quorum.
`RackName`	`String`	RO	A configured name that should be the same for members that are on the same physical "rack" (or frame or cage), and different for members that are on different physical "racks".
`ReceiverPacketUtilization`	`Float`	RO	The receiver packet utilization for this cluster node since the socket was last reopened. This value is a ratio of the number of bytes received to the number that would have been received had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
`ReceiverSuccessRate`	`Float`	RO	The receiver success rate for this cluster node since the node statistics were last reset. The receiver success rate is a ratio of the number of packets successfully acknowledged in a first attempt to the total number of received packets. A failure count is incremented when a re-delivery of previously received packet is detected. It could be caused by either very high inbound network latency or lost ACK packets.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`ResendDelay`	`Integer`	RW	The minimum number of milliseconds that a packet will remain queued in the Publisher`s re-send queue before it is resent to the recipient(s) if the packet has not been acknowledged. Setting this value too low can overflow the network with unnecessary repetitions. Setting the value too high can increase the overall latency by delaying the re-sends of dropped packets. Additionally, change of this value may need to be accompanied by a change in `SendAckDelay` value.
`RoleName`	`String`	RO	A configured name that can be used to indicate the role of a member to the application. While managed by Coherence, this property is only used by the application.
`SendAckDelay`	`Integer`	RW	The minimum number of milliseconds between the queueing and sending of an ACK packet. This value should be not more then a half of the `ResendDelay` value.
`SendQueueSize`	`Integer`	RO	The number of packets currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have already been sent and awaiting for acknowledgment. Packets that do not receive an acknowledgment within the `ResendDelay` interval will be automatically resent.
`SiteName`	`String`	RO	A configured name that should be the same for members that are on the same physical site (for example, data center), and different for members that are on different physical sites.
`SocketCount`	`Integer`	RO	Number of CPU sockets for the machine this member is running on.
`Statistics`	`String`	RO	Statistics for this cluster node in a human readable format.
`TcpRingFailures`	`Long`	RO	The number of recovered TcpRing disconnects since the node statistics were last reset. A recoverable disconnect is an abnormal event that is registered when the TcpRing peer drops the TCP connection, but recovers after no more than the maximum configured number of attempts. A `-1` value indicates that TcpRing is disabled.
`Timestamp`	`Date`	RO	The date/time value (in cluster time) that this member joined the cluster.
`TrafficJamCount`	`Integer`	RW	The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. Zero means no limit.
`TrafficJamDelay`	`Integer`	RW	The number of milliseconds to pause client threads when a traffic jam condition has been reached. Anything less than one (for example, zero) is treated as one millisecond.
`UnicastAddress`	`String`	RO	The IP address of the member`s datagram socket for point-to-point communication.
`UnicastPort`	`Integer`	RO	The port of the member`s datagram socket for point-to-point communication.
`WeakestChannel`	`Integer`	RO	The id of the cluster node to which this node is having the most difficulty communicating, or `-1` if none is found. A channel is considered to be weak if either the point-to-point publisher or receiver success rates are below 1.0.
`WellKnownAddresses`	`String[]`	RO	An array of well-known socket addresses that this member uses to join the cluster.

Operations

Table E-6 describes the operations for ClusterNodeMBean.

Table E-6 ClusterNodeMBean Operations

Operation	Parameters	Return Type	Description
`ensureCacheService`	`String sCacheName`	`void`	Ensure that a cache service for the specified cache runs at the cluster node represented by this MBean. This method will use the configurable cache factory to find out which cache service to start if necessary. Return value indicates the service name. A `null` value indicates a match could not be found.
`ensureInvocationService`	`String sServiceName`	`void`	Ensure that an invocation service with the specified name runs at the cluster node represented by this MBean.
`resetStatistics`	`void`	`void`	Reset the cluster node statistics.
`shutdown`	`void`	`void`	Stop all the clustered services running at this node (controlled shutdown). The management of this node will node be available until the node is restarted (manually or programmatically).

ConnectionManagerMBean

The ConnectionManagerMBean MBean represents a Coherence*Extend proxy. A cluster node may have zero or more instances of this managed bean depending on the number of configured proxies. The MBean contains statistics for throughput and connection information for proxy hosts.

The MBean's object name is:

type=ConnectionManager,name=service name,nodeId=cluster node's id

Attributes

Table E-7 describes the attributes for ConnectionManagerMBean.

Table E-7 ConnectionManagerMBean Attributes

Attribute	Type	Access	Description
`ConnectionCount`	`Integer`	RO	The number of client connections.
`HostIP`	`String`	RO	The IP address and port of the proxy host.
`IncomingBufferPoolCapacity`	`Long`	RO	The pool capacity (in bytes) of the incoming buffer.
`IncomingBufferPoolSize`	`Integer`	RO	The number of buffers in the incoming pool.
`OutgoingBufferPoolCapacity`	`Long`	RO	The pool capacity (in bytes) of the outgoing buffer.
`OutgoingBufferPoolSize`	`Integer`	RO	The number of buffers in the outgoing pool.
`OutgoingByteBacklog`	`Long`	RO	The backlog (in bytes) of the outgoing queue
`OutgoingMessageBacklog`	`Long`	RO	The backlog of the outgoing message queue.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`TotalBytesReceived`	`Long`	RO	The total number of bytes received by the proxy host since the statistics were last reset.
`TotalBytesSent`	`Long`	RO	The total number of bytes sent by the proxy host since the statistics were last reset.
`TotalMessagesReceived`	`Long`	RO	The total number of messages received by the proxy host since the statistics were last reset.
`TotalMessagesSent`	`Long`	RO	The total number of messages sent by the proxy host since the statistics were last reset.

Operations

The ConnectionManagerMBean MBean has no operations.

ConnectionMBean

The ConnectionMBean MBean represents a remote client connection through Coherence*Extend. A cluster node may have zero or more instances of this managed bean depending on the number of active remote connections to the cluster. The MBean contains performance and usage statistics for the connection.

The MBean's object name is:

type=Connection,name=service name ,nodeId=cluster node's id,UUID=connection's id

Attributes

Table E-8 describes the attributes for ConnectionMBean.

Table E-8 ConnectionMBean Attributes

Attribute	Type	Access	Description
`ConnectionTimeMillis`	`Long`	RO	The time duration (in milliseconds) that the client has been connected.
`OutgoingByteBacklog`	`Long`	RO	The backlog (in bytes) of the outgoing queue
`OutgoingMessageBacklog`	`Integer`	RO	The backlog of the outgoing message queue.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`RemoteAddress`	`String`	RO	The IP address of the corresponding client.
`RemotePort`	`Integer`	RO	The port of the corresponding client.
`Timestamp`	`Date`	RO	The date/time value (in local time) that the corresponding client connected to the proxy.
`TotalBytesReceived`	`Long`	RO	The total number of bytes received since the last time the statistics were reset.
`TotalBytesSent`	`Long`	RO	The total number of bytes sent since the last time the statistics were reset.
`TotalMessagesReceived`	`Long`	RO	The total number of messages received since the last time the statistics were reset.
`TotalMessagesSent`	`Long`	RO	The total number of messages sent since the last time the statistics were reset.
`UUID`	`String`	RO	The unique identifier for this connection.

Operations

Table E-9 describes the operations for ConnectionMBean.

Table E-9 ConnectionMBean Operations

Operation	Parameters	Return Type	Description
`closeConnection`	`void`	`void`	Close the corresponding connection.
`resetStatistics`	`void`	`void`	Reset the connection statistics.

ManagementMBean

The ManagementMBean MBean represents the grid JMX infrastructure. Each cluster node has a single instance of this managed bean. The MBean contains management settings. Some of the attributes are writable and allow management behavior to be changed in real time.

The MBean's object name is:

type=Management

Attributes

Table E-10 describes the attributes for ManagementMBean.

Table E-10 ManagementMBean Attributes

Attribute	Type	Access	Description
`ExpiryDelay`	`Long`	RW	The number of milliseconds that the MBean server will keep a remote model snapshot before refreshing.
`RefreshCount`	`Long`	RO	The total number of snapshots retrieved since the statistics were last reset.
`RefreshExcessCount`	`Long`	RO	The number of times the MBean server predictively refreshed information and the information was not accessed.
`RefreshOnQuery`	`Boolean`	RO	Specifies whether or not the refresh-on-query MBean server is configured. If this is `true` then the `RefreshPolicy` value should be `refresh-onquery`.
`RefreshPolicy`	`String`	RW	The policy used to determine the behavior when refreshing remote models. Valid values are: `refresh-ahead`, `refresh-behind`, `refresh-expired`, `refresh-onquery`. Invalid values will convert to `refresh-expired`.
`RefreshPredictionCount`	`Long`	RO	The number of times the MBean server used a predictive (`refresh-behind`, `refresh-ahead`, `refresh-onquery`) algorithm to refresh MBean information.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`RefreshTimeoutCount`	`Long`	RO	The number of times this management node has timed out while attempting to refresh remote MBean attributes.
`RemoteNotificationCount`	`Long`	RO	The total number of remote notifications received for all MBeans by this node since the last time the statistics were reset.

Operations

The ManagementMBean MBean includes a resetStatistics operation that resets the RefreshCount, RefreshExcessCount and RefreshPredictionCount statistics.

PointToPointMBean

The PointToPointMBean MBean represents the network status between two cluster members. Each cluster node has a single instance of this managed bean. The MBean provides network statistics from the perspective of the current viewing member with respect to a specified viewed member. To specify the member, enter its ID using the ViewedMemberId attribute.

The MBean's object name is:

type=PointToPoint,nodeId=cluster node's id

Attributes

Table E-11 describes the attributes for PointToPointMBean.

Table E-11 PointToPointMBean Attributes

Attribute	Type	Access	Description
`DeferredPackets`	`Integer`	RO	The number of packets addressed to the viewed member that the viewing member is currently deferring to send. The viewing member will delay sending these packets until the number of outstanding packets falls below the value of the Threshold attribute. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`Deferring`	`Boolean`	RO	Indicates whether or not the viewing member is currently deferring packets to the viewed member. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`LastIn`	`Long`	RO	The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member.
`LastOut`	`Long`	RO	The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member.
`LastSlow`	`Long`	RO	The number of milliseconds that have elapsed since the viewing member declared the viewed member as slow, or `-1` if the viewed member has never been declared slow.
`OutstandingPackets`	`Integer`	RO	The number of packets that the viewing member has sent to the viewed member which have yet to be acknowledged. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`PauseRate`	`Float`	RO	The percentage of time since the last time statistics were reset in which the viewing member considered the viewed member to be unresponsive. Under normal conditions this value should be very close to 0.0. Values near 1.0 would indicate that the viewed node is nearly inoperable, likely due to extremely long GC pauses. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`Paused`	`Boolean`	RO	Indicates whether or not the viewing member currently considers the viewed member to be unresponsive. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`PublisherSuccessRate`	`Float`	RO	The publisher success rate from the viewing node to the viewed node since the statistics were last reset.
`ReceiverSuccessRate`	`Float`	RO	The receiver success rate from the viewing node to the viewed node since the statistics were last reset.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`Threshold`	`Integer`	RO	The maximum number of outstanding packets for the viewed member that the viewing member is allowed to accumulate before initiating the deferral algorithm. The value of this attribute is only meaningful if the viewing member has `FlowControl` enabled. See "flow-control".
`ViewedMemberId`	`Integer`	RW	The Id of the member being viewed.
`ViewerStatistics`	`String[]`	RO	Human readable summary of the point-to-point statistics from the viewing member for all other members.

Operations

Table E-12 describes the operations for PointToPointMBean.

Table E-12 PointToPointMBean Operations

Operation	Parameters	Return Type	Description
`resetStatistics`	`void`	`void`	Reset the viewing member`s point-to-point statistics for all other members.
`trackWeakest`	`void`	`void`	Instruct the Point-to-Point MBean to track the weakest member. A viewed member is considered to be weak if either the corresponding publisher or receiver success rates are below 1.0.

ReporterMBean

The ReporterMBean MBean represents the Coherence JMX Reporter. Each cluster node has a single instance of this managed bean. The MBean contains settings and statistics for the reporter. Many of the attributes are writable and allow the reporter configuration to be changed in real time. In addition, the MBean contains operations that start and stop the reporter as well as run reports in real time.

The MBean's object name is:

type=Reporter

Attributes

Table E-13 describes the attributes for ReporterMBean.

Table E-13 ReporterMBean Attributes

Attribute	Type	Access	Description
`AutoStart`	`Boolean`	RO	Specifies whether the reporter starts automatically with the node.
`ConfigFile`	`String`	RW	The configuration file for the Reporter.
`CurrentBatch`	`Long`	RW	The batch identifier for the Reporter.
`IntervalSeconds`	`Long`	RW	The interval between executions in seconds.
`LastExectionTime`	`Date`	RO	The last time a report batch was executed. For local servers it is the local time.
`LastReport`	`String`	RO	The last report to execute.
`OutputPath`	`String`	RW	The path where report output will be located.
`RefreshTime`	`Date`	RO	The last time that the reporter statistics were reset. For local servers it is the local time.
`Reports`	`String[]`	RO	The list of reports executed.
`RunAverageMillis`	`Double`	RO	The average batch runtime in milliseconds since the statistics were last reset.
`RunLastMillis`	`Long`	RO	The last batch runtime in milliseconds since the statistics were last reset.
`RunMaxMillis`	`Long`	RO	The maximum batch runtime in milliseconds since the statistics were last reset.
`State`	`String`	RO	The state of the Reporter. Valid values are: `Running` (reports are being executed); `Waiting` (the reporter is waiting for the interval to complete); `Starting` (the reporter is being started); `Stopping` (the reporter is attempting to stop execution and waiting for running reports to complete); `Stopped` (the reporter is stopped); `Sleeping` (the reporter is sleeping).

Operations

Table E-14 describes the operations for ReporterMBean.

Table E-14 ReporterMBean Operations

Operation	Parameters	Return Type	Description
`Stop`	`void`	`void`	Stop the reporter.
`Start`	`void`	`void`	Start the reporter.
`RunReport`	`String sReportFile`	`void`	Run the specified report configuration file (for example (`reports/report-group.xml`) one time.
`resetStatistics`	`void`	`void`	Reset the reporter statistics.

ServiceMBean

The ServiceMBean MBean represents a clustered Service. A cluster node may have zero or more instances of this managed bean depending on the number of clustered services that are started. The MBean contains usage and performance statistics for a service. Some of the attributes are writable and allow the behavior of a service to be changed in real time. In addition, the MBean contains operations that are used to start and stop a service in real time.

The MBean's object name is:

type=Service,name=service name,nodeId=cluster node's id

Terminology

The terms task and request have unique definitions within Coherence. These definitions should be understood before setting the task-related and request-related attributes for ServiceMBean.

Task — A task is an invoked object that executes on one or more nodes. The objects include filters, invocation agents (entry processors and aggregators), or single-pass agents (Invocable objects).
Request — A request is the round trip required to complete a task. A request begins the moment a task is sent for execution by a client and includes the following:
- The time it takes to deliver the request to an executing node (server).
- The interval between the time the task is received and placed into a service queue until the execution starts.
- The task execution time.
- The time it takes to deliver a result back to the client.

Attributes

Table E-15 describes the attributes for ServiceMBean.

Table E-15 ServiceMBean Attributes

Attribute	Type	Access	Description
`BackupCount`	`Integer`	RO	The number of backups for every cache storage.
`BackupCountAfterWritebehind`	`Integer`	RO	The number of members of the partitioned (distributed) cache service that will retain backup data that does not require write-behind. That is, data that is not vulnerable to being lost even if the entire cluster were shut down.
`OwnedPartitionsBackup`	`Integer`	RO	The number of partitions that this member backs up (responsible for the backup storage).
`OwnedPartitionsPrimary`	`Integer`	RO	The number of partitions that this member owns (responsible for the primary storage).
`PartitionsAll`	`Integer`	RO	The total number of partitions that every cache storage will be divided into.
`PartitionsEndangered`	`Integer`	RO	The total number of partitions that are not currently backed up.
`PartitionsUnbalanced`	`Integer`	RO	The total number of primary and backup partitions which remain to be transferred until the partition distribution across the storage enabled service members is fully balanced.
`PartitionsVulnerable`	`Integer`	RO	The total number of partitions that are backed up on the same machine where the primary partition owner resides.
`QuorumStatus`	`String`	RO	The current state of the service quorum.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`RequestAverageDuration`	`Float`	RO	The average duration (in milliseconds) of an individual synchronous request issued by the service since the last time the statistics were reset.
`RequestMaxDuration`	`Long`	RO	The maximum duration (in milliseconds) of a synchronous request issued by the service since the last time the statistics were reset.
`RequestPendingCount`	`Long`	RO	The number of pending synchronous requests issued by the service.
`RequestPendingDuration`	`Long`	RO	The duration (in milliseconds) of the oldest pending synchronous request issued by the service.
`RequestTimeoutCount`	`Long`	RO	The total number of timed-out requests since the last time the statistics were reset.
`RequestTimeoutMillis`	`Long`	RW	The default timeout value in milliseconds for requests that can be timed-out (for example, implement the `com.tangosol.net.PriorityTask` interface) but do not explicitly specify the request timeout value.
`RequestTotalCount`	`Long`	RO	The total number of synchronous requests issued by the service since the last time the statistics were reset.
`Running`	`Boolean`	RO	Specifies whether or not the service is running.
`SeniorMemberId`	`Integer`	RO	The service senior member id. The value is `-1` If the service is not running.
`Statistics`	`String`	RO	Statistics for this service in human readable format.
`StatusHA`	`String`	RO	The High Availability (HA) status for this service. The value of `MACHINE-SAFE` means that all the cluster nodes running on any given machine could be stopped at once without data loss. The value of `NODE-SAFE` means that any cluster node could be stopped without data loss. The value of `ENDANGERED` indicates that abnormal termination of any cluster node that runs this service may cause data loss.
`StorageEnabled`	`Boolean`	RO	Specifies whether or not the local storage is enabled for this cluster member.
`StorageEnabledCount`	`Integer`	RO	Specifies the total number of cluster nodes running this service for which local storage is enabled.
`TaskAverageDuration`	`Float`	RO	The average duration (in milliseconds) of an individual task execution.
`TaskBacklog`	`Integer`	RO	The size of the backlog queue that holds tasks scheduled to be executed by one of the service threads.
`TaskCount`	`Long`	RO	The total number of executed tasks since the last time the statistics were reset.
`TaskHungCount`	`Integer`	RO	The total number of currently executing hung tasks.
`TaskHungDuration`	`Long`	RO	The longest currently executing hung task duration in milliseconds.
`TaskHungTaskId`	`String`	RO	The id of the of the longest currently executing hung task.
`TaskHungThresholdMillis`	`Long`	RW	The amount of time in milliseconds that a task can execute before it is considered hung. Note that a posted task that has not yet started is never considered as hung. This attribute is applied only if a thread pool is started (that is, the `ThreadCount` value is > `0`).
`TaskMaxBacklog`	`Integer`	RO	The maximum size of the backlog queue since the last time the statistics were reset.
`TaskTimeoutCount`	`Integer`	RO	The total number of timed-out tasks since the last time the statistics were reset.
`TaskTimeoutMillis`	`Long`	RW	The default timeout value in milliseconds for tasks that can be timed-out (for example, implement the `com.tangosol.net.PriorityTask` interface) but do not explicitly specify the task execution timeout value. This attribute is applied only if a thread pool is started (that is, the `ThreadCount` value is > `0`).
`ThreadAbandonedCount`	`Integer`	RO	The number of abandoned threads from the service thread pool. A thread is abandoned and replaced with a new thread if it executes a task for a period of time longer than execution timeout and all attempts to interrupt it fail.
`ThreadAverageActiveCount`	`Float`	RO	The average number of active (not idle) threads in the service thread pool since the last time the statistics were reset.
`ThreadCount`	`Integer`	RW	The number of threads in the service thread pool. This attribute can only be changed in real time if a service is configured to use a thread pool (that is, a thread count > `0`). If the value is `0` (the default) then only the service thread is used and a thread pool is never started. To initially set this value, configure the `thread-count` parameter either for the service in an operational override file or for a cache in the cache configuration file.
`ThreadIdleCount`	`Integer`	RO	The number of currently idle threads in the service thread pool.
`Type`	`String`	RO	The type identifier of the service.

Operations

Table E-16 describes the operations for ServiceMBean.

Table E-16 ServiceMBean Operations

Operation	Parameters	Return Type	Description
`reportOwnership`	`void`	`String`	Format the ownership info.
`resetStatistics`	`void`	`void`	Reset the service statistics.
`shutdown`	`void`	`void`	Stop the service. This is a controlled shut-down, and is preferred to the `stop` method.
`start`	`void`	`void`	Start the service.
`stop`	`void`	`void`	Hard-stop the service. Use the `shutdown` method for normal service termination.

StorageManagerMBean

The StorageManagerMBean MBean represents a storage instance for a storage-enabled distributed cache service. A Storage instance manages all index, listener, and lock information for the portion of the distributed cache managed by the local member. A cluster node may have zero or more instances of this managed bean depending on the number of configured distributed caches. The MBean contains usage statistics for the storage-enabled cache.

The MBean's object name is:

type=StorageManager,service=service name,cache=cache name,nodeId=cluster node's id

Attributes

Table E-17 describes the attributes for StorageManagerMBean.

Table E-17 StorageManagerMBean Attributes

Attribute	Type	Access	Description
`EventsDispatched`	`Long`	RO	The total number of events dispatched by the Storage Manager since the last time the statistics were reset.
`EvictionCount`	`Long`	RO	The number of evictions from the backing map managed by this Storage Manager caused by entries expiry or insert operations that would make the underlying backing map to reach its configured size limit. The eviction count is used to audit the cache size in a static system: `Cache Size = Insert Count - Remove Count - Eviction Count` Therefore, the eviction count is not reset by the reset statistics method.
`IndexInfo`	`String[]`	RO	An array of information for each index applied to the portion of the partitioned cache managed by the Storage Manager. Each element is a string value that includes a `ValueExtractor` description, ordered flag (`true` to indicate that the contents of the index are ordered; `false` otherwise), and cardinality (number of unique values indexed).
`InsertCount`	`Long`	RO	The number of inserts into the backing map managed by this Storage Manager. In addition to standard inserts caused by `put` and `invoke` operations or synthetic inserts caused by `get` operations with read-through backing map topology, this counter is incremented when distribution transfers move resources into the underlying backing map and is decremented when distribution transfers move data out. The insert count is used to audit the cache size in a static system: `Cache Size = Insert Count - Remove Count - Eviction Count` Therefore, the insert count is not reset by the reset statistics method.
`ListenerFilterCount`	I`nteger`	RO	The number of filter-based listeners currently registered with the Storage Manager.
`ListenerKeyCount`	`Integer`	RO	The number of key-based listeners currently registered with the Storage Manager.
`ListenerRegistrations`	`Long`	RO	The total number of listener registration requests processed by the Storage Manager since the last time the statistics were reset.
`LocksGranted`	`Integer`	RO	The number of locks currently granted for the portion of the partitioned cache managed by the Storage Manager.
`LocksPending`	`Integer`	RO	The number of pending lock requests for the portion of the partitioned cache managed by the Storage Manager.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`RemoveCount`	`Long`	RO	The number of removes from the backing map managed by this Storage Manager caused by operations such as `clear`, `remove` or `invoke`. The remove count is used to audit the cache size in a static system: `Cache Size = Insert Count - Remove Count - Eviction Count` Therefore, the remove count is not reset by the reset statistics method.
`TriggerInfo`	`String[]`	RO	An array of information for each trigger applied to the portion of the partitioned cache managed by the Storage Manager. Each element is a string value that represents a human-readable description of the corresponding `MapTrigger`.

Operations

The StorageManagerMBean MBean includes a resetStatistics operation that resets storage manager statistics. This operation does not reset the EvictionCount, InsertCount or RemoveCount attributes.

TransactionManagerMBean

The TransactionManagerMBean MBean represents a transaction manager and is specific to the transactional framework. A cluster node may have zero or more instances of this managed bean depending on the number of configured transaction caches. The MBean provides global transaction manager statics by aggregating service-level statistics from all transaction service instances. Each cluster node has an instance of the transaction manager managed bean per service.

The MBean's object name is:

type=TransactionManager,service=service name,nodeId=cluster node's id

Note:

For certain transaction manager attributes, the count is maintained at the coordinator node for the transaction, even though multiple nodes may have participated in the transaction. For example, a transaction may include modifications to entries stored on multiple nodes but the TotalCommitted attribute will only be incremented on the MBean on the node that coordinated the commit of that transaction.

Attributes

Table E-18 describes the attributes for TransactionManagerMBean.

Table E-18 TransactionManagerMBean Attributes

Attribute	Type	Access	Description
`CommitTotalMillis`	`Long`	RO	The cumulative time (in milliseconds) spent during the commit phase since the last time statistics were reset.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`TotalActive`	`Long`	RO	The total number of currently active transactions. An active transaction is counted as any transaction that contains at least one modified entry and has yet to be committed or rolled back. Note that the count is maintained at the coordinator node for the transaction, even though multiple nodes may have participated in the transaction.
`TotalCommitted`	`Long`	RO	The total number of transactions that have been committed by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being committed, even though multiple nodes may have participated in the transaction.
`TotalRecovered`	`Long`	RO	The total number of transactions that have been recovered by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being recovered, even though multiple nodes may have participated in the transaction.
`TotalRolledback`	`Long`	RO	The total number of transactions that have been rolled back by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being rolled back, even though multiple nodes may have participated in the transaction.
`TotalTransactionMillis`	`Long`	RO	The cumulative time (in milliseconds) spent on active transactions.
`TimeoutMillis`	`Long`	RO	The transaction timeout value in milliseconds. Note that this value will only apply to transactional connections obtained after the value is set. This attribute is currently not supported.
`CommitTotalMillis`	`Long`	RO	The cumulative time (in milliseconds) spent during the commit phase since the last time statistics were reset.
`RefreshTime`	`Date`	RO	The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
`TotalActive`	`Long`	RO	The total number of currently active transactions. An active transaction is counted as any transaction that contains at least one modified entry and has yet to be committed or rolled back. Note that the count is maintained at the coordinator node for the transaction, even though multiple nodes may have participated in the transaction.
`TotalCommitted`	`Long`	RO	The total number of transactions that have been committed by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being committed, even though multiple nodes may have participated in the transaction.
`TotalRecovered`	`Long`	RO	The total number of transactions that have been recovered by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being recovered, even though multiple nodes may have participated in the transaction.
`TotalRolledback`	`Long`	RO	The total number of transactions that have been rolled back by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being rolled back, even though multiple nodes may have participated in the transaction.

Operations

The TransactionManagerMBean MBean includes a resetStatistics operation that resets all transaction manager statistics.