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 Chapter 2, "Using JMX to Manage Coherence," for more information on accessing Coherence MBeans.
The following sections are included in this Appendix:
Table A-1 lists the MBeans that are provided for managing Coherence.
| MBean | Description |
|---|---|
|
Represents a cache. A cluster member may have zero or more instances of this managed bean. |
|
|
Represents a cluster object. Each cluster member has a single instance of this managed bean. |
|
|
Represents a cluster member. Each cluster member has a single instance of this managed bean. |
|
|
Represents a Coherence*Extend proxy. A cluster member may have zero or more instances of this managed bean. |
|
|
Represents a remote client connection through Coherence*Extend. A cluster member may have zero or more instances of this managed bean. |
|
|
Represents a flash journal resource manager. Each cluster member has a single instance of this managed bean. |
|
|
Represents the grid JMX infrastructure. Each cluster member has a single instance of this managed bean. |
|
|
Represents the network status between two cluster members. Each cluster member has a single instance of this managed bean. |
|
|
Represents a RAM journal resource manager. Each cluster member has a single instance of this managed bean. |
|
|
Represents the Coherence JMX Reporter. Each cluster member has a single instance of this managed bean. |
|
|
Represents a clustered Service. A cluster member may have zero or more instances of this managed bean. |
|
|
Represents a storage instance for a storage-enabled distributed cache service. A cluster member may have zero or more instances of this managed bean. |
|
|
Represents a transaction manager. A cluster member may have zero or more instances of this managed bean. |
The CacheMBean MBean represents a cache. A cluster member 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: TheCacheMBean 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 Oracle Coherence Developer's Guide for a list of the supported attributes and transaction-specific descriptions. |
Table A-2 describes the attributes for CacheMBean.
Table A-2 CacheMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The average number of milliseconds per |
|
|
|
RO |
The average number of milliseconds per |
|
|
|
RO |
The average number of milliseconds per |
|
|
|
RO |
The average number of milliseconds per put() invocation since the statistics were last reset. |
|
|
|
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 |
|
|
|
RO |
The rough number of cache hits since the statistics were last reset. A cache hit is a read operation invocation (that is, |
|
|
|
RO |
The total number of milliseconds (since the statistics were last reset) for the |
|
|
|
RO |
The rough number of cache misses since the statistics were last reset. |
|
|
|
RO |
The total number of milliseconds (since the statistics were last reset) for the |
|
|
|
RO |
The number of prune operations since the statistics were last reset. A prune operation occurs every time the cache reaches its high watermark as specified by the |
|
|
|
RO |
The total number of milliseconds for the prune operations since the statistics were last reset. |
|
|
|
RO |
The cache description. |
|
|
|
RW |
The time-to-live for cache entries in milliseconds. A value of zero indicates that the automatic expiry is disabled. Changing this attribute does not affect existing entries that are scheduled to expire. |
|
|
|
RW |
The limit of the cache size measured in units. The cache prunes itself automatically after it reaches its maximum unit level. This is often referred to as the high water mark of the cache. |
|
|
|
RO |
The rough probability ( |
|
|
|
RW |
The number of units to which the cache shrinks when it prunes. This is often referred to as a low water mark of the cache. |
|
|
|
RO |
The persistence type for this cache. Possible values include: |
|
|
|
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 |
|
|
|
RO |
The size of the write-behind queue size. This attribute is only applicable if the persistence type is |
|
|
|
RW |
This attribute is used to calculate the soft-expiration time for cache entries. Soft-expiration is the point in time before the actual expiration after which any access request for an entry schedules 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. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RW |
The maximum size of the write-behind queue for which failed cache store write operations are requeued. If zero, the write-behind requeueing is disabled. This attribute is only applicable if the persistence type is |
|
|
|
RO |
The number of entries in the cache. |
|
|
|
RO |
The average number of entries stored for each cache store write operation since the statistics were last reset. A call to the |
|
|
|
RO |
The average time (in milliseconds) spent per read operation since the statistics were last reset. The value is |
|
|
|
RO |
The average time (in milliseconds) spent per write operation since the statistics were last reset. The value is |
|
|
|
RO |
The total number of cache store failures (load, store and erase operations) since the statistics were last reset. The value is |
|
|
|
RO |
The cumulative time (in milliseconds) spent on load operations since the statistics were last reset. The value is |
|
|
|
RO |
The total number of load operations since the statistics were last reset. The value is |
|
|
|
RO |
The cumulative time (in milliseconds) spent on store and erase operations since the statistics were last reset. The value is |
|
|
|
RO |
The total number of store and erase operations since the statistics were last reset. The value is |
|
|
|
RO |
The total number of |
|
|
|
RO |
The total number of milliseconds spent on |
|
|
|
RO |
The total number of |
|
|
|
RO |
The total number of milliseconds spent on |
|
|
|
RO |
The factor by which the |
|
|
|
RO |
The size of the cache measured in units. This value must be adjusted by the |
The CacheMBean MBean includes a resetStatistics operation that resets all cache statistics.
The ClusterMBean MBean represents a cluster. Each cluster member has a single instance of this managed bean. This MBean provides operational statistics about the cluster.
The MBean's object name is:
type=Cluster
Table A-3 describes the attributes for ClusterMBean.
Table A-3 ClusterMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The name of the cluster. |
|
|
|
RO |
The total number of cluster members. |
|
|
|
RO |
The license mode that this cluster is using. Possible values are |
|
|
|
RO |
The member id for the cluster member that is collocated with the reporting MBean server. The value is |
|
|
|
RO |
An array of all existing cluster member ids. |
|
|
|
RO |
An array of all existing cluster members. |
|
|
|
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 member has joined the cluster and is reset when the MBean server member leaves and rejoins the cluster. The |
|
|
|
RO |
The number of times this member has observed another member`s departure from the cluster since this management member has joined the cluster or statistics have been reset. |
|
|
|
RO |
The senior cluster member id. The value is |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
Specifies whether the cluster is running. |
|
|
|
RO |
The Coherence version. |
Table A-4 describes the operations for ClusterMBean.
The ClusterNodeMBean MBean represents a cluster member. Each cluster member has a single instance of this managed bean. This MBean provides many operational and performance statistics for a member of a cluster. Many of the attributes are writable and allow the behavior of the member to be changed in real time.
The MBean's object name is:
type=Node,nodeId=cluster node's id
Table A-5 describes the attributes for ClusterNodeMBean.
Table A-5 ClusterNodeMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RW |
The buffer size of the unicast datagram socket used by the Publisher, measured in the number of packets. Changing this value at run time is an inherently unsafe operation that pauses all network communications and may result in the termination of all cluster services. |
|
|
|
RW |
The buffer size of the unicast datagram socket used by the Receiver, measured in the number of packets. Changing this value at run time is an inherently unsafe operation that pauses all network communications and may result in the termination of all cluster services. |
|
|
|
RO |
Number of CPU cores for the computer this member is running on. |
|
|
|
RO |
Indicates whether |
|
|
|
RO |
The short member id that uniquely identifies the member now and does not change for the life of this member. |
|
|
|
RO |
The output device used by the logging system. Valid values are |
|
|
|
RW |
Specifies how messages are formatted before being passed to the log destination. |
|
|
|
RW |
Specifies which logged messages are output to the log destination. Valid values are nonnegative integers. A value of |
|
|
|
RW |
The maximum number of characters that the logger daemon processes from the message queue before discarding all remaining messages in the queue. Valid values are positive integers in the range |
|
|
|
RO |
The member`s machine Id. |
|
|
|
RO |
A configured name that should be the same for all members that are on the same physical computer, and different for members that are on different physical computers. |
|
|
|
RO |
A configured name that must be unique for every member. |
|
|
|
RO |
The total amount of memory in the JVM available for new objects in MB. |
|
|
|
RO |
The maximum amount of memory that the JVM attempts to use in MB. |
|
|
|
RO |
The IP address of the member`s multicast socket for group communication. |
|
|
|
RO |
Specifies whether this member uses multicast for group communication. If |
|
|
|
RO |
The port of the member`s multicast socket for group communication. |
|
|
|
RO |
The time-to-live for multicast packets sent out on this member`s multicast socket. |
|
|
|
RW |
The percentage (0 to 100) of the servers in the cluster that a packet is sent to, above which the packet is sent using multicast and below which it is sent using unicast. |
|
|
|
RO |
Indicates whether the early packet loss detection protocol is enabled. |
|
|
|
RO |
The total number of NACK packets sent since the member statistics were last reset. |
|
|
|
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. |
|
|
|
RO |
The total number of packets which were bundled before transmission. The total number of network transmissions equals |
|
|
|
RO |
The number of packets received since the member statistics were last reset. |
|
|
|
RO |
The number of duplicate packets received since the member statistics were last reset. |
|
|
|
RO |
The number of packets resent since the member statistics were last reset. A packet is resent when there is no ACK received within a timeout period. |
|
|
|
RO |
The total number of packets resent too soon. A packet is resent too soon when there is a NACK indicating that the packet has not been received. |
|
|
|
RO |
The total number of packet retransmissions which were later proven unnecessary. |
|
|
|
RO |
The number of packets sent since the member statistics were last reset. |
|
|
|
RO |
The priority, or weight, of the member; used to determine tie-breakers. |
|
|
|
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 is calculated internally as the |
|
|
|
RO |
The product edition this member is running. Possible values are: |
|
|
|
RO |
The publisher packet utilization for this cluster member since the member 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. |
|
|
|
RO |
The publisher success rate for this cluster member since the member 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. |
|
|
|
RO |
The current state of the cluster quorum. |
|
|
|
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". |
|
|
|
RO |
The receiver packet utilization for this cluster member 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. |
|
|
|
RO |
The receiver success rate for this cluster member since the member 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. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RW |
The minimum number of milliseconds that a packet remains 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 require a change in the |
|
|
|
RO |
A configured name that can indicate the role of a member to the application. While managed by Coherence, this property is only used by the application. |
|
|
|
RW |
The minimum number of milliseconds between the queuing and sending of an ACK packet. This value should not be more then a half the |
|
|
|
RO |
The number of packets currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have been sent and awaiting for acknowledgment. Packets that do not receive an acknowledgment within the |
|
|
|
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. |
|
|
|
RO |
Number of CPU sockets for the computer this member is running on. |
|
|
|
RO |
Statistics for this cluster member in a human readable format. |
|
|
|
RO |
The number of recovered TcpRing disconnects since the member 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 |
|
|
|
RO |
The date/time value (in cluster time) that this member joined the cluster. |
|
|
|
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. |
|
|
|
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. |
|
|
|
RO |
The IP address of the member`s datagram socket for point-to-point communication. |
|
|
|
RO |
The port of the member`s datagram socket for point-to-point communication. |
|
|
|
RO |
The id of the cluster member to which this member is having the most difficulty communicating, or |
|
|
|
RO |
An array of well-known socket addresses that this member uses to join the cluster. |
Table A-6 describes the operations for ClusterNodeMBean.
Table A-6 ClusterNodeMBean Operations
| Operation | Parameters | Return Type | Description |
|---|---|---|---|
|
|
|
|
Ensure that a cache service for the specified cache runs at the cluster member represented by this MBean. This method uses the configurable cache factory to find out which cache service to start if necessary. |
|
|
|
|
Reset the cluster member statistics. |
|
|
|
|
Stop all the clustered services running at this member (controlled shutdown). The management of this member is not available until the member is restarted (manually or programmatically). |
The ConnectionManagerMBean MBean represents a Coherence*Extend proxy. A cluster member 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
Table A-7 describes the attributes for ConnectionManagerMBean.
Table A-7 ConnectionManagerMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The number of client connections. |
|
|
|
RO |
The IP address and port of the proxy host. |
|
|
|
RO |
The pool capacity (in bytes) of the incoming buffer. |
|
|
|
RO |
The number of buffers in the incoming pool. |
|
|
|
RO |
The pool capacity (in bytes) of the outgoing buffer. |
|
|
|
RO |
The number of buffers in the outgoing pool. |
|
|
|
RO |
The backlog (in bytes) of the outgoing queue |
|
|
|
RO |
The backlog of the outgoing message queue. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
The total number of bytes received by the proxy host since the statistics were last reset. |
|
|
|
RO |
The total number of bytes sent by the proxy host since the statistics were last reset. |
|
|
|
RO |
The total number of messages received by the proxy host since the statistics were last reset. |
|
|
|
RO |
The total number of messages sent by the proxy host since the statistics were last reset. |
The ConnectionManagerMBean MBean has no operations.
The ConnectionMBean MBean represents a remote client connection through Coherence*Extend. A cluster member 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
Table A-8 describes the attributes for ConnectionMBean.
Table A-8 ConnectionMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The time duration (in milliseconds) that the client has been connected. |
|
|
|
RO |
The client's member identity information. The value can be customized using the |
|
|
|
RO |
The backlog (in bytes) of the outgoing queue |
|
|
|
RO |
The backlog of the outgoing message queue. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
The IP address of the corresponding client. |
|
|
|
RO |
The port of the corresponding client. |
|
|
|
RO |
The date/time value (in local time) that the corresponding client connected to the proxy. |
|
|
|
RO |
The total number of bytes received since the last time the statistics were reset. |
|
|
|
RO |
The total number of bytes sent since the last time the statistics were reset. |
|
|
|
RO |
The total number of messages received since the last time the statistics were reset. |
|
|
|
RO |
The total number of messages sent since the last time the statistics were reset. |
|
|
|
RO |
The unique identifier for this connection. |
Table A-9 describes the operations for ConnectionMBean.
The JournalMBean MBean is a common interface that is used by the flash journal resource manager (FlashJournalRM). The resource manager is responsible for storing data to flash memory. Each cluster member has a single instance of this managed resource, which provides operational statistics.
The managed resource's object name is
type=Journal,name=FlashJournalRM,nodeId=cluster node's id
Table A-15 describes the attributes for FlashJournalRMMBean.
Table A-10 FlashJournalRMMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The number of serialized values that have yet to be persisted. |
|
|
|
RO |
The maximum size, in bytes, of the backlog. The backlog is the amount of serialized values that has yet to be persisted. Client threads are blocked if this limit is exceeded and remain blocked until the backlog recedes below this limit. |
|
|
|
RO |
The number of active |
|
|
|
RO |
The size of the buffers that are used to write data to a journal file. |
|
|
|
RO |
The threshold after which files are eligible for garbage collection. The larger the value, the more aggressively files are collected. |
|
|
|
RO |
The number of journal files that are currently in use. |
|
|
|
RO |
The maximum size, in bytes, of the backlog. Writes are delayed when the backlog exceeds this level and remain delayed until the backlog recedes below this level. |
|
|
|
RO |
The maximum allowable size of an individual journal file. |
|
|
|
RO |
The maximum number of journal files that can be used. |
|
|
|
RO |
The maximum size, in bytes, of the buffer pool. |
|
|
|
RO |
This attribute does not pertain to a flash journal and returns |
|
|
|
RO |
The maximum allowable size, in bytes, for serialized values. |
|
|
|
RO |
Whether the RAM journal uses on-heap byte buffers or off-heap NIO buffers (NIO RAM). Valid values are |
|
|
|
RO |
The total size, in bytes, of all available buffers in the pool. |
|
|
|
RO |
The amount of data, in bytes, that are currently stored for this journal. |
|
|
|
RO |
The total size of all journal files for this journal. |
There are no operations available for this managed resource.
The ManagementMBean MBean represents the grid JMX infrastructure. Each cluster member 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
Table A-11 describes the attributes for ManagementMBean.
Table A-11 ManagementMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RW |
The number of milliseconds that the MBean server keeps a remote model snapshot before refreshing. |
|
|
|
RO |
The total number of snapshots retrieved since the statistics were last reset. |
|
|
|
RO |
The number of times the MBean server predictively refreshed information and the information was not accessed. |
|
|
|
RO |
Specifies whether the refresh-on-query MBean server is configured. If this is |
|
|
|
RW |
The policy used to determine the behavior when refreshing remote models. Valid values are: |
|
|
|
RO |
The number of times the MBean server used a predictive ( |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
The number of times this management member has timed out while attempting to refresh remote MBean attributes. |
|
|
|
RO |
The total number of remote notifications received for all MBeans by this member since the last time the statistics were reset. |
The ManagementMBean MBean includes a resetStatistics operation that resets the RefreshCount, RefreshExcessCount and RefreshPredictionCount statistics.
The PointToPointMBean MBean represents the network status between two cluster members. Each cluster member has a single instance of this managed bean. The MBean provides network statistics from the perspective of the current viewing member 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
Table A-12 describes the attributes for PointToPointMBean.
Table A-12 PointToPointMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The number of packets addressed to the viewed member that the viewing member is currently deferring to send. The viewing member delays 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 |
|
|
|
RO |
Indicates whether the viewing member is currently deferring packets to the viewed member. The value of this attribute is only meaningful if the viewing member has |
|
|
|
RO |
The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member. |
|
|
|
RO |
The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member. |
|
|
|
RO |
The number of milliseconds that have elapsed since the viewing member declared the viewed member as slow, or |
|
|
|
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 |
|
|
|
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 member is nearly inoperable, likely due to extremely long GC pauses. The value of this attribute is only meaningful if the viewing member has |
|
|
|
RO |
Indicates whether the viewing member currently considers the viewed member to be unresponsive. The value of this attribute is only meaningful if the viewing member has |
|
|
|
RO |
The publisher success rate from the viewing member to the viewed member since the statistics were last reset. |
|
|
|
RO |
The receiver success rate from the viewing member to the viewed member since the statistics were last reset. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
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 |
|
|
|
RW |
The Id of the member being viewed. |
|
|
|
RO |
Human readable summary of the point-to-point statistics from the viewing member for all other members. |
Table A-13 describes the operations for PointToPointMBean.
Table A-13 PointToPointMBean Operations
| Operation | Parameters | Return Type | Description |
|---|---|---|---|
|
|
|
|
Reset the viewing member`s point-to-point statistics for all other members. |
|
|
|
|
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. |
The JournalMBean MBean is a common interface that is used by the RAM journal resource manager (RamJournalRM). The resource manager is responsible for storing data to RAM memory. Each cluster member has a single instance of this managed resource, which provides operational statistics.
The managed resource's object name is:
type=Journal,name=RamJournalRM,nodeId=cluster node's id
Table A-15 describes the attributes for RamJournalRMMBean.
Table A-14 RamJournalRMMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
This attribute does not pertain to a RAM journal and returns |
|
|
|
RO |
This attribute does not pertain to a RAM journal and returns |
|
|
|
RO |
The number of active |
|
|
|
RO |
This attribute does not pertain to a RAM journal and returns |
|
|
|
RO |
The threshold after which files are eligible for garbage collection. The larger the value, the more aggressively files are collected. |
|
|
|
RO |
The number of journal files that are currently in use. |
|
|
|
RO |
This attribute does not pertain to a RAM journal and returns |
|
|
|
RO |
The maximum allowable size of an individual journal file. |
|
|
|
RO |
The maximum number of journal files that can be used. |
|
|
|
RO |
The maximum size, in bytes, of the buffer pool. |
|
|
|
RO |
The total amount of RAM used for this journal. |
|
|
|
RO |
The maximum allowable size, in bytes, for serialized values. |
|
|
|
RO |
Whether the RAM journal uses on-heap byte buffers or off-heap NIO buffers (NIO RAM). Valid values are |
|
|
|
RO |
This attribute does not pertain to a RAM journal and returns |
|
|
|
RO |
The amount of data, in bytes, that are currently stored for this journal. |
|
|
|
RO |
The total size of all journal files for this journal. |
There are no operations available for this managed resource.
The ReporterMBean MBean represents the Coherence JMX Reporter. Each cluster member has a single instance of this managed bean. The MBean contains settings and statistics for JMX reporting. Many of the attributes are writable and allow JMX reporting to be changed in real time. In addition, the MBean contains operations that start and stop reporting and run reports in real time.
The MBean's object name is:
type=Reporter
Table A-15 describes the attributes for ReporterMBean.
Table A-15 ReporterMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
Specifies whether JMX reporting starts automatically with the member. |
|
|
|
RW |
The report group configuration file to be used for JMX reporting. |
|
|
|
RW |
The batch identifier for the Reporter. |
|
|
|
RW |
The interval between executions in seconds. |
|
|
|
RO |
The last time a report batch was executed. For local servers it is the local time. |
|
|
|
RO |
The last report to execute. |
|
|
|
RW |
The path where report output is located. |
|
|
|
RO |
The last time that the reporter statistics were reset. For local servers it is the local time. |
|
|
|
RO |
The list of reports executed. |
|
|
|
RO |
The average batch run in milliseconds since the statistics were last reset. |
|
|
|
RO |
The last batch run in milliseconds since the statistics were last reset. |
|
|
|
RO |
The maximum batch run in milliseconds since the statistics were last reset. |
|
|
|
RO |
The state of JMX reporting. Valid values are: |
Table A-16 describes the operations for ReporterMBean.
Table A-16 ReporterMBean Operations
| Operation | Parameters | Return Type | Description |
|---|---|---|---|
|
|
NA |
|
Stop JMX reporting. |
|
|
|
|
Start JMX reporting. |
|
|
|
|
Run a report group or single report one time using the specified report group or report file, respectively (for example ( |
|
|
|
|
Reset the reporter statistics. |
The ServiceMBean MBean represents a clustered Service. A cluster member 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
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 members. 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 member (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.
Table A-17 describes the attributes for ServiceMBean.
Table A-17 ServiceMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The number of backups for every cache storage. |
|
|
|
RO |
The number of members of the partitioned (distributed) cache service that 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. |
|
|
|
RO |
The number of partitions that this member backs up (responsible for the backup storage). |
|
|
|
RO |
The number of partitions that this member owns (responsible for the primary storage). |
|
|
|
RO |
The total number of partitions that every cache storage is divided into. |
|
|
|
RO |
The total number of partitions that are not currently backed up. |
|
|
|
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. |
|
|
|
RO |
The total number of partitions that are backed up on the same computer where the primary partition owner resides. |
|
|
|
RO |
The current state of the service quorum. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
The average duration (in milliseconds) of an individual synchronous request issued by the service since the last time the statistics were reset. |
|
|
|
RO |
The maximum duration (in milliseconds) of a synchronous request issued by the service since the last time the statistics were reset. |
|
|
|
RO |
The number of pending synchronous requests issued by the service. |
|
|
|
RO |
The duration (in milliseconds) of the oldest pending synchronous request issued by the service. |
|
|
|
RO |
The total number of timed-out requests since the last time the statistics were reset. |
|
|
|
RW |
The default timeout value in milliseconds for requests that can be timed-out (for example, implement the |
|
|
|
RO |
The total number of synchronous requests issued by the service since the last time the statistics were reset. |
|
|
|
RO |
Specifies whether the service is running. |
|
|
|
RO |
The service senior member id. The value is |
|
|
|
RO |
Statistics for this service in human readable format. |
|
|
|
RO |
The High Availability (HA) status for this service. The value of |
|
|
|
RO |
Specifies whether the local storage is enabled for this cluster member. |
|
|
|
RO |
Specifies the total number of cluster members running this service for which local storage is enabled. |
|
|
|
RO |
The average duration (in milliseconds) of an individual task execution. |
|
|
|
RO |
The size of the backlog queue that holds tasks scheduled to be executed by a service thread. |
|
|
|
RO |
The total number of executed tasks since the last time the statistics were reset. |
|
|
|
RO |
The total number of currently executing hung tasks. |
|
|
|
RO |
The longest currently executing hung task duration in milliseconds. |
|
|
|
RO |
The id of the longest currently executing hung task. |
|
|
|
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 |
|
|
|
RO |
The maximum size of the backlog queue since the last time the statistics were reset. |
|
|
|
RO |
The total number of timed-out tasks since the last time the statistics were reset. |
|
|
|
RW |
The default timeout value in milliseconds for tasks that can be timed-out (for example, implement the This attribute is applied only if a thread pool is started (that is, the |
|
|
|
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 longer than the execution timeout and all attempts to interrupt it fail. |
|
|
|
RO |
The average number of active (not idle) threads in the service thread pool since the last time the statistics were reset. |
|
|
|
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 > |
|
|
|
RO |
The number of currently idle threads in the service thread pool. |
|
|
|
RO |
The type identifier of the service. |
Table A-18 describes the operations for ServiceMBean.
Table A-18 ServiceMBean Operations
| Operation | Parameters | Return Type | Description |
|---|---|---|---|
|
|
|
|
Reports the partitions owned by the service on this node. The |
|
|
NA |
|
Reset the service statistics. |
|
|
|
|
Stop the service. This is a controlled shut-down, and is preferred to the |
|
|
|
|
Start the service. |
|
|
|
|
Hard-stop the service. Use the |
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 member 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 and also includes statistics for queries.
The MBean's object name is:
type=StorageManager,service=service name,cache=cache name,nodeId=cluster node's id
Table A-19 describes the attributes for StorageManagerMBean.
Table A-19 StorageManagerMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The total number of events dispatched by the Storage Manager since the last time the statistics were reset. |
|
|
|
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:
Therefore, the eviction count is not reset by the reset statistics method. |
|
|
|
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 |
|
|
|
RO |
The number of inserts into the backing map managed by this Storage Manager. In addition to standard inserts caused by The insert count is used to audit the cache size in a static system:
Therefore, the insert count is not reset by the reset statistics method. |
|
|
I |
RO |
The number of filter-based listeners currently registered with the Storage Manager. |
|
|
|
RO |
The number of key-based listeners currently registered with the Storage Manager. |
|
|
|
RO |
The total number of listener registration requests processed by the Storage Manager since the last time the statistics were reset. |
|
|
|
RO |
The number of locks currently granted for the portion of the partitioned cache managed by the Storage Manager. |
|
|
|
RO |
The number of pending lock requests for the portion of the partitioned cache managed by the Storage Manager. |
|
|
|
RO |
A description of the query with the longest duration that exceeds the |
|
|
|
RO |
The number of milliseconds of the longest running query since the statistics were last reset. |
|
|
|
RW |
A threshold, in milliseconds, for recording queries. The longest query that executes longer than this threshold is reported by |
|
|
|
RO |
The average duration, in milliseconds, for non-optimized query execution since the cache statistics were last reset. |
|
|
|
RO |
The total number of parallel queries that could not be resolved (or that were partially resolved) using indexes since the statistics were last reset. |
|
|
|
RO |
The total execution time, in milliseconds for queries that could not be resolved (or that were partially resolved) using indexes since the statistics were last reset |
|
|
|
RO |
The average duration, in milliseconds, per optimized query execution since the statistics were last reset. |
|
|
|
RO |
The total number of queries that were fully resolved using indexes since the statistics were last reset. |
|
|
|
RO |
The total execution time, in milliseconds, for queries that were fully resolved using indexes since the statistics were last reset. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
RO |
The number of removes from the backing map managed by this Storage Manager caused by operations such as The remove count is used to audit the cache size in a static system:
Therefore, the remove count is not reset by the reset statistics method. |
|
|
|
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 |
The StorageManagerMBean MBean includes a resetStatistics operation that resets storage manager statistics. This operation does not reset the EvictionCount, InsertCount or RemoveCount attributes.
The TransactionManagerMBean MBean represents a transaction manager and is specific to the transactional framework. A cluster member 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 member 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 member for the transaction, even though multiple members may have participated in the transaction. For example, a transaction may include modifications to entries stored on multiple members but theTotalCommitted attribute is only incremented on the MBean on the member that coordinated the commit of that transaction. |
Table A-20 describes the attributes for TransactionManagerMBean.
Table A-20 TransactionManagerMBean Attributes
| Attribute | Type | Access | Description |
|---|---|---|---|
|
|
|
RO |
The cumulative time (in milliseconds) spent during the commit phase since the last time statistics were reset. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
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 member for the transaction, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being committed, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being recovered, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being rolled back, even though multiple members may have participated in the transaction. |
|
|
|
RO |
The cumulative time (in milliseconds) spent on active transactions. |
|
|
|
RO |
The transaction timeout value in milliseconds. Note that this value only applies to transactional connections obtained after the value is set. This attribute is currently not supported. |
|
|
|
RO |
The cumulative time (in milliseconds) spent during the commit phase since the last time statistics were reset. |
|
|
|
RO |
The timestamp when this model was last retrieved from a corresponding member. For local servers it is the local time. |
|
|
|
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 member for the transaction, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being committed, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being recovered, even though multiple members may have participated in the transaction. |
|
|
|
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 member for the transaction being rolled back, even though multiple members may have participated in the transaction. |
The TransactionManagerMBean MBean includes a resetStatistics operation that resets all transaction manager statistics.