A Oracle Coherence MBeans Reference

The MBean reference provides a detailed description of all Coherence MBeans including their attributes and operations. In addition to the MBean reference, the Registration interface provides descriptions of the MBeans. In addition, an MBean-capable agent (such as JConsole) also shows MBean information. See Using JMX to Manage Oracle Coherence.

This reference includes the following MBeans:

CacheMBean

The CacheMBean MBean represents a cache and provides operational and performance statistics. Some MBean attributes are writable and allow the behavior of a cache to be changed in real time. A cluster member includes 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).

The object name of the MBean is:

type=Cache,service=service name,name=cache name,nodeId=cluster node 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 attributes are invoked that do not apply. See CacheMBeans for Transactional Caches in Developing Applications with Oracle Coherence.

Attributes

Table A-1 describes the attributes for CacheMBean.

Table A-1 CacheMBean Attributes

Attribute Type Access Description

AverageGetMillis

Double

read-only

The average number of milliseconds for each get() invocation since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

AverageHitMillis

Double

read-only

The average number of milliseconds for each get() invocation that is a hit. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

AverageMissMillis

Double

read-only

The average number of milliseconds for each get() invocation that is a miss. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

AveragePutMillis

Double

read-only

The average number of milliseconds for each put() invocation since the cache statistics were last reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

BatchFactor

Double

read/write

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 before 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

read-only

The rough number of cache visits since the statistics were last reset. A cache hit is a read operation invocation (that is, get()) for which an entry exists in this map.

CacheHitsMillis

Long

read-only

The total number of milliseconds (since the statistics were last reset) for the get() operations for which an entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

CacheMisses

Long

read-only

The rough number of cache misses since the statistics were last reset

CacheMissesMillis

Long

read-only

The total number of milliseconds (since the statistics were last reset) for the get() operations for which no entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

CachePrunes

Long

read-only

The number of prune operations since the statistics were last reset. A prune operation occurs every time the cache reaches its high-water mark as specified by the HighUnits attribute.

CachePrunesMillis

Long

read-only

The total number of milliseconds for the prune operations since the statistics were last reset

CacheStoreType

String

read-only

The cache store type for this cache. Possible values include: NONE, READ-ONLY, WRITE-THROUGH, WRITE-BEHIND.

Description

String

read-only

The cache description

ExpiryDelay

Integer

read/write

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.

HighUnits

Integer

read/write

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.

HitProbability

Double

read-only

The rough probability (0 <= p <= 1) that the next invocation is a hit since the last time statistics were reset

LowUnits

Integer

read/write

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

QueueDelay

Integer

read/write

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 cache store type is WRITE-BEHIND.

QueueSize

Integer

read-only

The size of the write-behind queue. This attribute is only applicable if the cache store type is WRITE-BEHIND.

RefreshFactor

Double

read/write

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 that 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 the factor is zero, refresh-ahead scheduling is disabled.

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RequeueThreshold

Integer

read/write

The size of the write-behind queue at which additional actions could be taken. If the size is zero, write-behind requeuing is disabled. Otherwise, this value controls the frequency of the corresponding log messages. For example, a value of 100 produces a log message every time the size of the write queue is a multiple of 100.

Size

Integer

read-only

The number of entries in the cache

StoreAverageBatchSize

Long

read-only

The average number of entries stored for each cache store write operation since the statistics were last reset. 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 cache store type is NONE.

StoreAverageReadMillis

Long

read-only

The average time (in milliseconds) spent per read operation since the statistics were last reset. The value is -1 if the cache store type is NONE.

StoreAverageWriteMillis

Long

read-only

The average time (in milliseconds) spent per write operation since the statistics were last reset. The value is -1 if the cache store type is NONE.

StoreFailures

Long

read-only

The total number of cache store failures (load, store, and erase operations) since the statistics were last reset. The value is -1 if the cache store type is NONE.

StoreReadMillis

Long

read-only

The cumulative time (in milliseconds) spent on load operations since the statistics were last reset. The value is -1 if the cache store type is NONE.

StoreReads

Long

read-only

The total number of load operations since the statistics were last reset. The value is -1 if the cache store type is NONE.

StoreWriteMillis

Long

read-only

The cumulative time (in milliseconds) spent on store and erase operations since the statistics were last reset. The value is -1 if the cache store type is NONE or READ-ONLY.

StoreWrites

Long

read-only

The total number of store and erase operations since the statistics were last reset. The value is -1 if the cache store type is NONE or READ-ONLY.

TotalGets

Long

read-only

The total number of get() operations since the statistics were last reset

TotalGetsMillis

Long

read-only

The total number of milliseconds spent on get() operations since the statistics were last reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

TotalPuts

Long

read-only

The total number of put() operations since the statistics were last reset

TotalPutsMillis

Long

read-only

The total number of milliseconds spent on put() operations since the statistics were last reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache).

UnitFactor

Integer

read-only

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

read-only

The size of the cache measured in units. This value must 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 and provides operational statistics. Each cluster member includes a single instance of this managed bean.

The object name of the MBean is:

type=Cluster

Attributes

Table A-2 describes the attributes for ClusterMBean.

Table A-2 ClusterMBean Attributes

Attribute Type Access Description

ClusterName

String

read-only

The name of the cluster

ClusterSize

Integer

read-only

The total number of cluster members

LicenseMode

String

read-only

The license mode that this cluster is using. Possible values are Evaluation, Development, or Production.

LocalMemberId

Integer

read-only

The member ID for the cluster member that is collocated with the reporting MBean server. The value is -1 if the cluster service is not running.

MemberIds

Integer[]

read-only

An array of all existing cluster member IDs

Members

String[]

read-only

An array of all existing cluster members

MembersDeparted

String[]

read-only

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 MembersDepartureCount is the total count of departed members and not the size of this array.

MembersDepartureCount

Long

read-only

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.

OldestMemberId

Integer

read-only

The senior cluster member ID. The value is -1 if the cluster service is not running.

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

Running

Boolean

read-only

Specifies whether the cluster is running

Version

String

read-only

The Oracle Coherence version

Operations

Table A-3 describes the operations for ClusterMBean.

Table A-3 ClusterMBean Operations

Operation Parameters Return Type Description

suspendService

String sService

Void

Suspends all members of the service identified by the specified name. A suspended service is in a deactivated state in preparation to be shutdown. Once suspended, a service can be resumed or reactivated with the resumeService operation. If Cluster is used as the service name, then all services (including the cluster service) are suspended.

shutdown

Not applicable

Void

Shuts down the cluster service on this member.

resumeService

String sService

Void

Resumes all suspended members of the service identified by the specified name. If Cluster is used as the service name, then all services (including the cluster service) are resumed.

logClusterState

String sRole

Void

Logs the state (full thread dump and outstanding polls) on cluster members that are running with the specified role. The role of a cluster member is defined within the <member-identity> element of an operational override file. See Specifying a Cluster Member's Identity in Developing Applications with Oracle Coherence. If the sRole parameter is not specified (no value in the field), then state is logged on all cluster members.

ensureRunning

Not applicable

Void

Ensures that the cluster service is running on this member.

configureTracing

String sRole, float fRatio

Void

Configures the tracing sampling ratio for those members matching the specified role, or if sRole is null or empty, configures the tracing ratio for all cluster members.

Valid values for fRatio are -1 and 0 through 1.0 (inclusive).

ClusterNodeMBean

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

The object name of the MBean is:

type=Node,nodeId=cluster node id

Attributes

Table A-4 describes the attributes for ClusterNodeMBean.

Table A-4 ClusterNodeMBean Attributes

Attribute Type Access Description

BufferPublishSize

Integer

read/write

The buffer size of the unicast datagram socket that is 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.

BufferReceiveSize

Integer

read/write

The buffer size of the unicast datagram socket that is 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.

CpuCount

Integer

read-only

Number of CPU cores for the computer on which this member is running.

FlowControlEnabled

Boolean

read-only

Indicates whether FlowControl is enabled. See flow-control in Developing Applications with Oracle Coherence.

Id

Integer

read-only

The short member ID that uniquely identifies the member now and does not change for the life of this member.

LoggingDestination

String

read-only

The output device used by the logging system. Valid values are stdout, stderr, jdk, log4j, or a file name.

LoggingFormat

String

read/write

Specifies how messages are formatted before being passed to the log destination.

LoggingLevel

Integer

read/write

Specifies which logged messages are output to the log destination. Valid values are nonnegative integers. A value of -1 disables all logger output.

LoggingLimit

Integer

read/write

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 0 to Integer.MAX_VALUE (2147483647). A value of zero implies Integer.MAX_VALUE.

MachineId

Integer

read-only

The computer ID of this member.

MachineName

String

read-only

A unique name for the computer. The name should be the same for all members that are on the same computer and different for members that are on different computers.

MemberName

String

read-only

A unique name for a member. The name must be unique for every member.

MemoryAvailableMB

Integer

read-only

The total amount of memory (in MB) that is available in the JVM for new objects.

MemoryMaxMB

Integer

read-only

The maximum amount of memory (in MB) that the JVM attempts to use.

MulticastAddress

String

read-only

The multicast socket IP address that is used by this member for group communication.

MulticastEnabled

Boolean

read-only

Specifies whether this member uses multicast for group communication. If false, this member uses 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

read-only

The multicast socket port that is used by this member for group communication.

MulticastThreshold

Integer

read/write

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.

MulticastTTL

Integer

read-only

The time-to-live for multicast packets that were sent out on this member`s multicast socket.

NackEnabled

Boolean

read-only

Indicates whether the early packet loss detection protocol is enabled.

NackSent

Long

read-only

The total number of NACK packets that were sent since the member statistics were last reset.

PacketDeliveryEfficiency

Float

read-only

The efficiency of packet loss detection and retransmission. A low efficiency indicates a high rate of unnecessary packet retransmissions.

PacketsBundled

Long

read-only

The total number of packets that were bundled before transmission. The total number of network transmissions equals PacketsSent - PacketsBundled.

PacketsReceived

Long

read-only

The number of packets that were received since the member statistics were last reset.

PacketsRepeated

Long

read-only

The number of duplicate packets that were received since the member statistics were last reset.

PacketsResent

Long

read-only

The number of packets that were re-sent since the member statistics were last reset. A packet is re-sent when there is no ACK received within a timeout period.

PacketsResentEarly

Long

read-only

The total number of packets that were re-sent too soon. A packet is re-sent too soon when there is a NACK indicating that the packet has not been received.

PacketsResentExcess

Long

read-only

The total number of packet retransmissions that were later proven unnecessary.

PacketsSent

Long

read-only

The number of packets that were sent since the member statistics were last reset.

Priority

Integer

read-only

The priority, or weight, of the member. This value is used to determine tie-breakers.

ProcessName

String

read-only

A 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 Name attribute of the system RuntimeMXBean, which normally represents the process identifier (PID).

ProductEdition

String

read-only

The product edition this member is running. Possible values are Standard Edition, Enterprise Edition, and Grid Edition.

PublisherPacketUtilization

Float

read-only

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.

PublisherSuccessRate

Float

read-only

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.

QuorumStatus

String

read-only

The current state of the cluster quorum.

RackName

String

read-only

A name for the rack on which the member is located. This name 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

read-only

The receiver packet utilization for this cluster member since the socket was last reopened. This value is a ratio of the number of bytes that were 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

read-only

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 that were successfully acknowledged in a first attempt to the total number of received packets. A failure count increments when a redelivery of a previously received packet is detected. Very high inbound network latency or lost ACK packets can cause a low success rate.

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

ResendDelay

Integer

read/write

The minimum number of milliseconds that a packet remains queued in the publisher`s resend queue before it is re-sent to any recipients 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-sending of dropped packets. Change of this value may require a change in the SendAckDelay value.

RoleName

String

read-only

A name that indicates the role of a cluster member to the application. Use a name that is meaningful to the application.

SendAckDelay

Integer

read/write

The minimum number of milliseconds between the queuing and sending of an ACK packet. This value should not be more then half of the ResendDelay value.

SendQueueSize

Integer

read-only

The number of packets that are currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have been sent and are awaiting for an acknowledgment. Packets that do not receive an acknowledgment within the ResendDelay interval are automatically re-sent.

SiteName

String

read-only

A name for the site where the member is located. The name 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

read-only

The number of CPU sockets for the computer on which this member is running.

Statistics

String

read-only

The statistics for this cluster member in a human readable format.

TcpRingFailures

Long

read-only

The number of TcpRing disconnects that were recovered 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 value of -1 indicates that TcpRing is disabled.

Timestamp

Date

read-only

The date/time value (in cluster time) that this member joined the cluster.

TracingSamplingRatio

Float

read/write

The ratio of spans to capture when tracing is enabled. A value of -1 disables tracing. A value of 0 means Coherence will not initiate tracing unless an active span is already present. A value between 0 (exclusively) and 1.0 (inclusively) represents the percentage of tracing spans that will be captured.

TrafficJamCount

Integer

read/write

The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. A value of zero means no limit.

TrafficJamDelay

Integer

read/write

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

read-only

The datagram socket IP address that is used by this member for point-to-point communication.

UnicastPort

Integer

read-only

The datagram socket port that is used by this member for point-to-point communication.

WeakestChannel

Integer

read-only

The ID of the cluster member to which this member 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[]

read-only

An array of well-known socket addresses that this member uses to join the cluster.

Operations

Table A-5 describes the operations for ClusterNodeMBean.

Table A-5 ClusterNodeMBean Operations

Operation Parameters Return Type Description

ensureService

String sCacheName

void

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.

resetStatistics

Not applicable

void

Reset the cluster member statistics

logNodeSate

Not applicable

void

Logs a full thread dump and outstanding polls for the services on this cluster member

shutdown

Not applicable

void

Stop all the clustered services running at this member (controlled shutdown). The management of this member is not available until the member restarts (manually or programmatically).

ConnectionManagerMBean

The ConnectionManagerMBean MBean represents an Oracle Coherence*Extend proxy and provides statistics for throughput and connection information. A cluster member includes zero or more instances of this managed bean depending on the number of configured proxies.

The object name of the MBean is:

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

Attributes

Table A-6 describes the attributes for ConnectionManagerMBean.

Table A-6 ConnectionManagerMBean Attributes

Attribute Type Access Description

AverageRequestTime

Float

read-only

The average processing time in milliseconds for HTTP requests

ConnectionCount

Integer

read-only

The number of client connections

HostIP

String

read-only

The IP address and port of the proxy host

HTTPServerType

String

read-only

The type of HTTP server or n/a if the HTTP protocol is not used

IncomingBufferPoolCapacity

Long

read-only

The pool capacity (in bytes) of the incoming buffer

IncomingBufferPoolSize

Integer

read-only

The number of buffers in the incoming pool

MessagingDebug

Boolean

read/write

The debug flag. If the flag set to true and the logging level on the node is set to 6 or higher, then sent and received messages are logged for all the connections under this service.

OutgoingBufferPoolCapacity

Long

read-only

The pool capacity (in bytes) of the outgoing buffer

OutgoingBufferPoolSize

Integer

read-only

The number of buffers in the outgoing pool

OutgoingByteBacklog

Long

read-only

The backlog (in bytes) of the outgoing queue

OutgoingMessageBacklog

Long

read-only

The backlog of the outgoing message queue

Protocol

String

read-only

The protocol associated with this ConnectionManagerMBean instance. Valid values are tcp or http.

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RequestsPerSecond

Float

read-only

The number of HTTP requests per second since the statistics were reset

ResponseCount1xx

Long

read-only

The number of HTTP responses in the 100-199 range

ResponseCount2xx

Long

read-only

The number of HTTP responses in the 200-299 range

ResponseCount3xx

Long

read-only

The number of HTTP responses in the 300-399 range

ResponseCount4xx

Long

read-only

The number of HTTP responses in the 400-499 range

ResponseCount5xx

Long

read-only

The number of HTTP responses in the 500-599 range

TotalBytesReceived

Long

read-only

The total number of bytes that were received by the proxy host since the statistics were last reset

TotalBytesSent

Long

read-only

The total number of bytes that were sent by the proxy host since the statistics were last reset

TotalErrorCount

Long

read-only

The number of HTTP requests that caused errors

TotalMessagesReceived

Long

read-only

The total number of messages that were received by the proxy host since the statistics were last reset

TotalMessagesSent

Long

read-only

The total number of messages that were sent by the proxy host since the statistics were last reset

TotalRequestCount

Long

read-only

The number of requests since the HTTP server was started or the statistics were reset

UnauthorizedConnectionAttempts

Long

read-only

The number of connection attempts from unauthorized hosts.

Operations

The ConnectionManagerMBean MBean includes a resetStatistics operation that resets destination statistics.

ConnectionMBean

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

The object name of the MBean is:

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

Attributes

Table A-7 describes the attributes for ConnectionMBean.

Table A-7 ConnectionMBean Attributes

Attribute Type Access Description

ConnectionTimeMillis

Long

read-only

The time duration (in milliseconds) that the client has been connected

Member

String

read-only

The member identity information for the client. The value can be customized using the <member-identity> element in the client operational override file. See Specifying a Cluster Member's Identity in Developing Applications with Oracle Coherence.

OutgoingByteBacklog

Long

read-only

The backlog (in bytes) of the outgoing queue

OutgoingMessageBacklog

Integer

read-only

The backlog of the outgoing message queue

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RemoteAddress

String

read-only

The IP address of the corresponding client

RemotePort

Integer

read-only

The port of the corresponding client

Timestamp

Date

read-only

The date/time value (in local time) that the corresponding client connected to the proxy

TotalBytesReceived

Long

read-only

The total number of bytes that were received since the last time the statistics were reset

TotalBytesSent

Long

read-only

The total number of bytes that were sent since the last time the statistics were reset

TotalMessagesReceived

Long

read-only

The total number of messages that were received since the last time the statistics were reset

TotalMessagesSent

Long

read-only

The total number of messages that were sent since the last time the statistics were reset

UUID

String

read-only

The unique identifier for this connection

Operations

Table A-8 describes the operations for ConnectionMBean.

Table A-8 ConnectionMBean Operations

Operation Parameters Return Type Description

closeConnection

Not applicable

void

Close the corresponding connection.

resetStatistics

Not applicable

void

Reset the connection statistics.

DestinationMBean

The DestinationMBean MBean represents a federation participant and provides performance statistics. One or more managed beans is registered depending on the number of federation participants that can receive data.

The object name of the MBean is:

Coherence:type=Federation,service=federated,subType=Destination,name=participant name,nodeId=cluster node id

Attributes

Table A-9 describes the attributes for DestinationMBean.

Table A-9 DestinationMBean Attributes

Attribute Type Access Description

BytesSentSecs

Long

read-only

The bytes sent per second

ConnectRetryTimeoutMillis

Long

read-only

The configured connect retry timeout

CurrentBandwidth

Double

read-only

The current utilized bandwidth in Megabits per second for sending replicate message

ErrorDescription

String

read-only

An error description. A value is only returned if the sender is in an ERROR state.

EstimatedReplicateAllRemainingTime

Long

read-only

The estimated remaining time (in milliseconds) in completing the replicateAll request

GeoIp

String

read-only

The location metadata that is configured for the participant

MaxBandwidth

Double

read-only

The maximum bandwidth in megabits per second for sending replicate messages. A value of -1.0 means the maximum bandwidth is not configured.

Member

String

read-only

The member information of the destination node.

MsgApplyTimePercentileMillis

Long

read-only

The 90-percentile value of the time (in milliseconds) it took to apply the replication messages on the destination

MsgNetworkRoundTripTimePercentileMillis

Long

read-only

The 90-percentile value of the time (in milliseconds) taken by transmission of replication messages and the corresponding acknowledge messages over the network

MsgsSentSecs

Long

read-only

The messages sent per second

Name

String

read-only

The name of the sender

ParticipantType

String

read-only

The participant type. Valid types are cluster and interceptor.

RecordBacklogDelayTimePercentileMillis

Long

read-only

The 90-percentile value of the time (in milliseconds) the journal records are in the cache waiting to be replicated

ReplicateAllPercentComplete

Long

read-only

The percent of work completed for a replicateAll request

ReplicateAllTotalTime

Long

read-only

The total time (in milliseconds) the replicateAll request took

SendTimeoutMillis

Long

read-only

The send timeout that is configured for the participant

State

String

read-only

The state of the participant. One of: INITIAL, IDLE, READY, SENDING, CONNECTING, CONNECT_WAIT, STOPPED, PAUSED, ERROR, YIELDING, BACKLOG_EXCESSIVE, BACKLOG_NORMAL, DISCONNECTED

Status

Integer

read-only

The status of the participant. Statuses are:

  • 0 – Ok

  • 1 – Warning

  • 2 – Error

TotalBytesSent

Long

read-only

The total number of bytes that were sent

TotalEntriesSent

Long

read-only

The total number of cache entries that were sent

TotalErrorResponses

Long

read-only

The total number of responses with error. Check the log for details of the errors.

TotalMsgSent

Long

read-only

The total number of replication messages that were sent. A replication message can contain multiple journal records.

TotalMsgUnacked

Long

read-only

The total number of un-acknowledged replication messages

TotalRecordsSent

Long

read-only

The total number of journal records that were sent. A journal record can consist of multiple cache entries that are part of the same transaction

Operations

The DestinationMBean MBean includes a resetStatistics operation that resets destination statistics.

FederationManagerMBean

The FederationManagerMBean MBean represents a FederatedCache service instance and provides operations that control replication of data to service participants. One or more managed beans is registered depending on the number of service instances.

The object name of the MBean is:

Coherence:type=Federation,service=service name,responsibility=Coordinator

Attributes

Table A-10 describes the attributes for FederationManagerMBean.

Table A-10 FederationManagerMBean Attributes

Attribute Type Access Description

CoordinatorId

Integer

read-only

The member identifier for the federation coordinator node

LocalParticipantName

String

read-only

The name of the local participant for this cluster

TraceLogging Boolean read/write Indicates whether the federation trace logging is enabled or not.

Operations

Table A-11 describes the operations for FederationManagerMBean.

Table A-11 FederationManagerMBean Operations

Operation Parameters Return Type Description

start

String p1

void

Start federating data to the entered participant. A value of null starts federating to all participants. The connection is established lazily only when there is data to be replicated.

startWithNoBacklog

String p1

void

Start federating to the entered participant and clear any initial backlog. A value of null starts federating to all participants. The connection is established lazily only when there is data to be federated.

startWithSync

String p1

void

Start federating to the entered participant and perform a ReplicateAll operation to synchronize the participant. A value of null starts federating to all participants. The connection is established lazily only when there is data to be federated.

stop

String p1

void

Stop federating data to the entered participant. A value of null stops federating to all participants.

pause

String p1

void

Pause federating data to the entered participant. A value of null pauses federating to all participants.

reportState

String p1

Map

Return a Map that indicates the state of the entered participant. The key in the map represents the state and the value represents the percent of service members that are in that state.

replicateAll

String p1

void

Asynchronously replicate all caches to the entered participant

retrievePendingOutgoingMessages

Not applicable

Integer

Number of pending outgoing federation messages

retrievePendingIncomingMessages

Not applicable

Integer

Number of incoming federation messages currently being processed

listNonFederatedCaches

String p1

String[]

A list of the names of the caches that belong to a Federated Cache Service but are not being federated.

FlashJournalRM

The JournalMBean MBean provides an interface for the flash journal resource manager (FlashJournalRM) and provides operational statistics. The resource manager stores data to flash memory. Each cluster member includes a single instance of this managed bean.

The object name of the MBean is:

type=Journal,name=FlashJournalRM,nodeId=cluster node id

Attributes

Table A-12 describes the attributes for JournalMBean that pertain to the flash journal resource manager.

Table A-12 JournalMBean Attributes for FlashJournalRM

Attribute Type Access Description

BacklogCount

Integer

read-only

The number of serialized values that have yet to be stored in the journal

BacklogSize

Integer

read-only

The amount of data that has been enqueued for the journal to write to disk, but which has not yet been written to disk. The maximum amount of memory used by the backlog is at least twice the configured amount, because the data enqueued is held in binary form and rendered to the write-behind buffers.

BinaryStoreCount

Integer

read-only

The number of active JournalBinaryStore objects that are using this journal

BufferSize

Integer

read-only

The size of the buffers that are used to write data to a journal file

CollectorLoadFactor

Double

read-only

The threshold after which files are eligible for garbage collection. The larger the value, the more aggressively files are collected.

CurrentCollectorLoadFactor

Double

read-only

The current load factor threshold at which files are being garbage collected

FileCount

Integer

read-only

The number of journal files that are currently in use

HighFileCount

Integer

read-only

The high file count after which compulsory compaction (garbage collection) occurs for the Journal

HighestLoadFactor

Double

read-only

The approximate high-water mark of the Journal capacity utilization

MaxBacklogSize

Integer

read-only

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.

MaxFileSize

Long

read-only

The maximum allowable size of an individual journal file

MaxJournalFilesNumber

Integer

read-only

The maximum number of journal files that can be used

MaxPoolSize

Integer

read-only

The maximum size, in bytes, of the buffer pool

MaxTotalRam

Long

read-only

This attribute does not pertain to a flash journal and returns -1.

MaxValueSize

Integer

read-only

The maximum allowable size, in bytes, for serialized values

NioRam

Boolean

read-only

Whether the RAM journal uses on-heap byte buffers or off-heap NIO buffers (NIO RAM). Valid values are true and false. A true value indicates off-heap NIO buffers. A false value indicates on-heap byte buffers. The default value is false.

PoolSize

Integer

read-only

The total size, in bytes, of all available buffers in the pool

TotalCompactionCount

Integer

read-only

The total number of times compaction (garbage collection) has been done for the journal

TotalDataSize

Long

read-only

The amount of data, in bytes, that is currently stored for this journal

TotalFileSize

Long

read-only

The total size of all journal files for this journal

Operations

The JournalMBean MBean has no operations.

ManagementMBean

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

The object name of the MBean is:

type=Management

Attributes

Table A-13 describes the attributes for ManagementMBean.

Table A-13 ManagementMBean Attributes

Attribute Type Access Description

ExpiryDelay

Long

read/write

The number of milliseconds that the MBean server keeps a remote model snapshot before refreshing

RefreshCount

Long

read-only

The total number of snapshots retrieved since the statistics were last reset

RefreshExcessCount

Long

read-only

The number of times that the MBean server predictively refreshed information and the information was not accessed

RefreshOnQuery

Boolean

read-only

Specifies whether the refresh-on-query MBean server is configured. If this is true, then the RefreshPolicy value should be refresh-onquery.

RefreshPolicy

String

read/write

The policy that determines the behavior when refreshing remote models. Valid values are refresh-ahead, refresh-behind, refresh-expired, and refresh-onquery. Invalid values are converted to refresh-expired.

RefreshPredictionCount

Long

read-only

The number of times that the MBean server used a predictive (refresh-behind, refresh-ahead, refresh-onquery) algorithm to refresh MBean information

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RefreshTimeoutCount

Long

read-only

The number of times that this management member has timed out while attempting to refresh remote MBean attributes

RemoteNotificationCount

Long

read-only

The total number of remote notifications that were received for all MBeans by this member since the last time the statistics were reset

Operations

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

OriginMBean

The OriginMBean MBean represents a federation participant and provides performance statistics. One or more managed beans is registered depending on the number of federation participants that can send data.

The object name of the MBean is:

Coherence:type=Federation,service=federated,subType=Origin,name=participant name,nodeId=cluster node id

Attributes

Table A-14 describes the attributes for OriginMBean.

Table A-14 OriginMBean Attributes

Attribute Type Access Description

BytesReceivedSecs

Long

read-only

The bytes received per second

Member

String

read-only

The member information of the in-coming participant node

MsgApplyTimePercentileMillis

Long

read-only

The 90-percentile value of the time (in milliseconds) it took to apply the replication messages on the destination.

MsgsReceivedSecs

Long

read-only

The messages received per second

RecordBacklogDelayTimePercentileMillis

Long

read-only

The 90-percentile value of the time (in milliseconds) the journal records are in the cache waiting to be replicated

TotalBytesReceived

Long

read-only

The total number of bytes that were received

TotalEntriesReceived

Long

read-only

The total number of cache entries that were received

TotalMsgReceived

Long

read-only

The total number of replication messages that were received. A replication message could contain multiple journal records

TotalMsgUnacked

Long

read-only

The total number of un-acknowledged replication messages

TotalRecordsReceived

Long

read-only

The total number of journal records that were received. A journal record could consist of multiple cache entries that are part of the same transaction

Operations

The OriginMBean MBean includes a resetStatistics operation that resets destination statistics.

PersistenceManagerMBean

The PersistenceManagerMBean provides attributes and operations related to persisting and recovering the contents of distributed cache services. Each service instance includes a single instance of this managed bean.

The object name of the MBean is:

type=Persistence,service=service name,responsibility=PersistenceCoordinator

Attributes

Table A-15 describes the attributes for PersistenceManagerMBean.

Table A-15 PersistenceManagerMBean Attributes

Attribute Type Access Description

OperationsStatus

String

read-only

The status of the current operation issued by the persistence coordinator

ManagerId

Integer

read-only

The member id of the service node that is the persistence coordinator

Snapshots

String[]

read-only

The list of snapshot identifiers that are available to recover from

Idle

Boolean

read-only

Whether or not the persistence coordinator is idle

Operations

Table A-16 describes the operations for PersistenceManagerMBean.

Table A-16 PersistenceManagerMBean Operations

Operation Parameters Return Type Description

archiveSnapshot

String sName

void

Archive the snapshot to a centralized location. This operation is asynchronous.

createSnapshot

String sName

void

Create a snapshot of the service with the specified name. This operation is asynchronous.

forceRecovery

Not applicable

void

Proceed with recovery despite the dynamic quorum policy objections. This may lead to the partial or full data loss at the corresponding cache service.

listArchivedSnapshots

Not applicable

String[]

Return a list of archived snapshots for the service

listArchivedSnapshotsStores

String sName

String[]

Return a list of stores for the archived snapshot with the specified name

removeArchivedSnapshot

String sName

void

Remove the archived snapshot from a centralized location

recoverSnapshot

String sName

void

Recover from a snapshot of the service with the specified name. This operation is asynchronous.

retrieveArchivedSnapshot

String sName

void

Retrieve the archived snapshot from a centralized location. This operation is asynchronous.

removeSnapshot

String sName

void

Remove the snapshot of the service with the specified name. This operation is asynchronous.

Notifications

Table A-17 describes the notifications for PersistenceManagerMBean.

Table A-17 PersistenceManagerMBean Notifications

Notification Description

ARCHIVE_SNAPSHOT_BEGIN

Indicates the start of archiving a snapshot

ARCHIVE_SNAPSHOT_END

Indicates the end of archiving a snapshot

CREATE_SNAPSHOT_BEGIN

Indicates the start of snapshot creation

CREATE_SNAPSHOT_END

Indicates the end of snapshot creation

RECOVER_BEGIN

Indicates the start of recovery

RECOVER_DISALOWED

Indicates recovery being disallowed by the quorum

RECOVER_END

Indicates the end of recovery

RECOVER_SNAPSHOT_BEGIN

Indicates the start of recovering to a snapshot

RECOVER_SNAPSHOT_END

Indicates the end of recovering to a snapshot

REMOVE_ARCHIVED_SNAPSHOT_BEGIN

Indicates the start of removing an archived snapshot

REMOVE_ARCHIVED_SNAPSHOT_END

Indicates the end of removing an archived snapshot

REMOVE_SNAPSHOT_BEGIN

Indicates the start of removing a snapshot

REMOVE_SNAPSHOT_END

Indicates the end of removing a snapshot

RETRIEVE_ARCHIVED_SNAPSHOT_BEGIN

Indicates the start of retrieving an archived snapshot

RETRIEVE_ARCHIVED_SNAPSHOT_END

Indicates the end of retrieving an archiving snapshot

PointToPointMBean

The PointToPointMBean MBean represents the network status between two cluster members and 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. Each cluster member includes a single instance of this managed bean.

The object name of the MBean is:

type=PointToPoint,nodeId=cluster node id

Attributes

Table A-18 describes the attributes for PointToPointMBean.

Table A-18 PointToPointMBean Attributes

Attribute Type Access Description

DeferredPackets

Integer

read-only

The number of packets that were 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 FlowControl enabled. See flow-control in Developing Applications with Oracle Coherence.

Deferring

Boolean

read-only

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 FlowControl enabled. See flow-control in Developing Applications with Oracle Coherence.

LastIn

Long

read-only

The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member

LastOut

Long

read-only

The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member

LastSlow

Long

read-only

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

read-only

The number of packets that the viewing member has sent to the viewed member that have yet to be acknowledged. The value of this attribute is only meaningful if the viewing member has FlowControl enabled. See flow-control in Developing Applications with Oracle Coherence.

PauseRate

Float

read-only

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 garbage collection. The value of this attribute is only meaningful if the viewing member has FlowControl enabled. See flow-control in Developing Applications with Oracle Coherence.

Paused

Boolean

read-only

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 FlowControl enabled. See flow-control in Developing Applications with Oracle Coherence.

PublisherSuccessRate

Float

read-only

The publisher success rate from the viewing member to the viewed member since the statistics were last reset

ReceiverSuccessRate

Float

read-only

The receiver success rate from the viewing member to the viewed member since the statistics were last reset

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time

Threshold

Integer

read-only

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 in Developing Applications with Oracle Coherence.

ViewedMemberId

Integer

read/write

The ID of the member being viewed

ViewerStatistics

String[]

read-only

A human readable summary of the point-to-point statistics from the viewing member for all other members

Operations

Table A-19 describes the operations for PointToPointMBean.

Table A-19 PointToPointMBean Operations

Operation Parameters Return Type Description

resetStatistics

Not applicable

void

Reset the viewing member`s point-to-point statistics for all other members.

trackWeakest

Not applicable

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 rate is below 1.0.

RamJournalRM

The JournalMBean MBean provides an interface for the RAM journal resource manager (RamJournalRM) and provides operational statistics. The resource manager is responsible for storing data to RAM memory. Each cluster member includes a single instance of this managed bean.

The object name of the MBean is:

type=Journal,name=RamJournalRM,nodeId=cluster node id

Attributes

Table A-20 describes the attributes for JournalMBean that pertain to the RAM journal resource manager.

Table A-20 JournalMBean Attributes for RamJournalRM

Attribute Type Access Description

BacklogCount

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

BacklogSize

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

BinaryStoreCount

Integer

read-only

The number of active JournalBinaryStore objects that are using this journal

BufferSize

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

CollectorLoadFactor

Double

read-only

The threshold after which files are eligible for garbage collection. The larger the value, the more aggressively files are collected.

CurrentCollectorLoadFactor

Double

read-only

The current load factor threshold at which files are being garbage collected

FileCount

Integer

read-only

The number of journal files that are currently in use

HighFileCount

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

HighestLoadFactor

Double

read-only

This attribute does not pertain to a RAM journal and returns 0.0.

MaxBacklogSize

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

MaxFileSize

Long

read-only

The maximum allowable size of an individual journal file

MaxJournalFilesNumber

Integer

read-only

The maximum number of journal files that can be used

MaxPoolSize

Integer

read-only

The maximum size, in bytes, of the buffer pool

MaxTotalRam

Long

read-only

The total amount of RAM used for this journal

MaxValueSize

Integer

read-only

The maximum allowable size, in bytes, for serialized values

NioRam

Boolean

read-only

Whether the RAM journal uses on-heap byte buffers or off-heap NIO buffers (NIO RAM). Valid values are true and false. A true value indicates off-heap NIO buffers. A false value indicates on-heap byte buffers. The default value is false.

PoolSize

Integer

read-only

This attribute does not pertain to a RAM journal and returns -1.

TotalCompactionCount

Integer

read-only

The total number of times compaction (garbage collection) has been done for the journal

TotalDataSize

Long

read-only

The amount of data, in bytes, that is currently stored for this journal

TotalFileSize

Long

read-only

The total size of all journal files for this journal

Operations

The JournalMBean MBean has no operations.

ReporterMBean

The ReporterMBean MBean represents the Oracle Coherence Reporter and provides settings and statistics for Oracle Coherence reporting. Many of the attributes are writable and change reporting behavior in real time. In addition, the MBean contains operations that start and stop reporting and run reports in real time. Each cluster member includes a single instance of this managed bean.

The object name of the MBean is:

type=Reporter

Attributes

Table A-21 describes the attributes for ReporterMBean.

Table A-21 ReporterMBean Attributes

Attribute Type Access Description

AutoStart

Boolean

read-only

Specifies whether reporting starts automatically with the member

ConfigFile

String

read/write

The report group configuration file to be used for reporting

CurrentBatch

Long

read/write

The batch identifier for the reporter

IntervalSeconds

Long

read/write

The interval between executions in seconds

LastExectionTime

Date

read-only

The last time a report batch ran. For local servers, it is the local time.

LastReport

String

read-only

The last report to execute

OutputPath

String

read/write

The path where report output is located

RefreshTime

Date

read-only

The last time that the reporter statistics were reset. For local servers, it is the local time.

Reports

String[]

read-only

The list of reports that were created

RunAverageMillis

Double

read-only

The average batch run in milliseconds since the statistics were last reset

RunLastMillis

Long

read-only

The last batch run in milliseconds since the statistics were last reset

RunMaxMillis

Long

read-only

The maximum batch run in milliseconds since the statistics were last reset

State

String

read-only

The reporting state. Valid values are Running (reports are being created), Waiting (the reporter is waiting for the interval to complete), Starting (the reporter is being started), Stopping (the reporter is attempting to stop and waiting for running reports to complete), Stopped (the reporter is stopped) and, Sleeping (the reporter is sleeping).

Operations

Table A-22 describes the operations for ReporterMBean.

Table A-22 ReporterMBean Operations

Operation Parameters Return Type Description

resetStatistics

Not applicable

void

Reset the reporter statistics.

runReport

String sReportFile

void

Run a report group or single report one time using the specified report group or report file, respectively (for example (reports/report-group.xml or reports/report-cache-size.xml).

runTabularReport

String sReportFile

TabularData

Run a report group or single report one time using the specified report group or report file, respectively (for example (reports/report-group.xml or reports/report-cache-size.xml). The results are returned in a table format in a separate window.

You can also directly enter the XML syntax of a report group or report file. If you enter the XML of a report group, the individual reports must be found on the classpath.

runTabularGroupReport

String sReportName

Map mapXmlReports

TabularData

Run a report group one time and pass in the individual reports' XML content. The results are returned in a table format in a separate window.

start

Not applicable

void

Start reporting

stop

Not applicable

void

Stop reporting

ServiceMBean

The ServiceMBean MBean represents a clustered service and provides usage and performance statistics. Some of the attributes are writable and change the behavior of a service in real time. In addition, the MBean contains operations to start and stop a service in real time. A cluster member includes zero or more instances of this managed bean depending on the number of clustered services that are started.

The object name of the MBean is:

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

Terminology

The terms task and request have unique definitions within Oracle Coherence. Understand the terms 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

Attributes

Table A-23 describes the attributes for ServiceMBean.

Table A-23 ServiceMBean Attributes

Attribute Type Access Description

BackupCount

Integer

read-only

The number of backups for every cache storage

BackupCountAfterWritebehind

Integer

read-only

The number of members of the partitioned (distributed) cache service that retain backup data, which does not require write-behind. The data is not vulnerable to being lost even if the entire cluster is shut down.

EventInterceptorInfo

String[]

read-only

An array of statistics for live events processed by event interceptors. The statistics include:

  • Interceptors – a list of registered interceptors

  • ExceptionCount – the number of exceptions thrown from the interceptors since the last time the statistics were reset

  • LastException – a stack trace of the last exception thrown from the interceptors

JoinTime

Date

read-only

The date and time (in cluster time) that this member joined the service

MemberCount

Integer

read-only

The total number of cluster nodes running this service

MessagesLocal

Long

read-only

The total number of messages which were self-addressed messages since the last time the statistics were reset. Such messages are used for servicing process-local requests and do not have an associated network cost

MessagesReceived

Long

read-only

The total number of messages received by this service since the last time the statistics were reset. This value accounts for messages received by any (local, dedicated or shared) transport

MessagesSent

Long

read-only

The number of messages sent by this service since the last time the statistics were reset. This value accounts for messages sent by any (local, dedicated or shared) transport

OutgoingTransferCount

Integer

read-only

The number of partitions that are currently being transferred by this service member to other members

OwnedPartitionsBackup

Integer

read-only

The number of partitions that this member backs up (responsible for the backup storage)

OwnedPartitionsPrimary

Integer

read-only

The number of partitions that this member owns (responsible for the primary storage)

PartitionsAll

Integer

read-only

The total number of partitions that every cache storage is divided into

PartitionsEndangered

Integer

read-only

The total number of partitions that are not currently backed up

PartitionsUnbalanced

Integer

read-only

The total number of primary and backup partitions that remain to be transferred until the partition distribution across the storage enabled service members is fully balanced

PartitionsVulnerable

Integer

read-only

The total number of partitions that are backed up on the same machine where the primary partition owner resides

PersistenceActiveSpaceAvailable

Long

read-only

The remaining space (in bytes) available on the file system for active persistence

PersistenceActiveSpaceTotal

Long

read-only

The total size (in bytes) of the file system for use by active persistence

PersistenceActiveSpaceUsed

Long

read-only

The amount of space (in bytes) that is used by active persistence

PersistenceEnvironment

String

read-only

A description of the configured persistence environment or n/a if one has not been configured.

PersistenceLatencyAverage

Float

read-only

The average latency (in milliseconds) added to a mutating cache operation by active persistence operations

PersistenceLatencyMax

Long

read-only

The maximum latency (in milliseconds) added to a mutating cache operation by an active persistence operation

PersistenceMode

String

read-only

The current persistence mode for this service:

  • active – all mutating cache operations are persisted using the configured persistence environment.

  • on-demand – a persistence environment has been configured and is available but is not being actively used.

  • n/a – persistence is not configured for this service.

PersistenceSnapshotArchiver

String

read-only

A description of the configured snapshot archiver or n/a if one has not been configured.

PersistenceSnapshotSpaceAvailable

Long

read-only

The remaining space (in bytes) available on the file system to store snapshots

PersistenceSnapshotSpaceTotal

Long

read-only

The total size (in bytes) of the file system to store snapshots

QuorumStatus

String

read-only

The current state of the service quorum

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RequestAverageDuration

Float

read-only

The average duration (in milliseconds) of an individual request that was issued by the service since the last time the statistics were reset

RequestMaxDuration

Long

read-only

The maximum duration (in milliseconds) of a request that was issued by the service since the last time the statistics were reset

RequestPendingCount

Long

read-only

The number of pending requests that were issued by the service

RequestPendingDuration

Long

read-only

The duration (in milliseconds) of the oldest pending request that was issued by the service

RequestTimeoutCount

Long

read-only

The total number of timed-out requests since the last time the statistics were reset

RequestTimeoutMillis

Long

read/write

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

read-only

The total number of synchronous requests that were issued by the service since the last time the statistics were reset

Running

Boolean

read-only

Specifies whether the service is running

SeniorMemberId

Integer

read-only

The service senior member ID. The value is -1 if the service is not running.

Statistics

String

read-only

The statistics for this service in a human readable format

StatusHA

String

read-only

The High Availability (HA) status for this service. A value of MACHINE-SAFE indicates that all the cluster members running on any given computer could be stopped without data loss. A value of NODE-SAFE indicates that a cluster member could be stopped without data loss. A value of ENDANGERED indicates that abnormal termination of any cluster member that runs this service may cause data loss. A value of N/A indicates that the service has no high availability impact.

StorageEnabled

Boolean

read-only

Specifies whether the local storage is enabled for this cluster member

StorageEnabledCount

Integer

read-only

Specifies the total number of cluster members running this service for which local storage is enabled

TaskAverageDuration

Float

read-only

The average duration (in milliseconds) of an individual task execution

TaskBacklog

Integer

read-only

The size of the backlog queue that holds tasks scheduled to be executed by a service thread

TaskCount

Long

read-only

The total number of executed tasks since the last time the statistics were reset

TaskHungCount

Integer

read-only

The total number of currently executing hung tasks

TaskHungDuration

Long

read-only

The longest currently executing hung task duration in milliseconds

TaskHungTaskId

String

read-only

The ID of the longest currently executing hung task

TaskHungThresholdMillis

Long

read/write

The amount of time in milliseconds that a task can execute before it is considered hung. 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

read-only

The maximum size of the backlog queue since the last time the statistics were reset

TaskTimeoutCount

Integer

read-only

The total number of timed-out tasks since the last time the statistics were reset

TaskTimeoutMillis

Long

read/write

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

read-only

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.

ThreadAverageActiveCount

Float

read-only

The average number of active (not idle) threads in the service thread pool since the last time the statistics were reset

ThreadCount

Integer

read/write

The number of threads in the service thread pool. To configure a thread count, set the thread-count-min and thread-count-max elements to the same value.

ThreadCountMax

Integer

read/write

The maximum number of daemon threads. Usage of daemon threads varies for different service types. If zero or negative, the service does not use daemon threads and all relevant tasks are performed on the service thread. Furthermore, if negative, tasks are performed on the caller's thread where possible.

ThreadCountMin

Integer

read/write

The minimum number of daemon threads. Usage of daemon threads varies for different service types. If zero or negative, the service does not use daemon threads and all relevant tasks are performed on the service thread. Furthermore, if negative, tasks are performed on the caller's thread where possible.

ThreadCountUpdateTime

Date

read-only

The last time an update was made to the thread count. This attribute is only valid when the ThreadPoolSizingEnabled attribute is true.

ThreadIdleCount

Integer

read-only

The number of currently idle threads in the service thread pool

ThreadPoolSizingEnabled

Boolean

read-only

Specifies whether dynamic thread pool sizing is enabled for this service. To enable dynamic thread pools, the thread-count-min and thread-count-max elements must be set on the service.

TransportAddress

String

read-only

The service-dedicated transport address. If an address is shown (indicating that a reliable transport has been enabled on the service), then the service instance communicates with other service members using the dedicated transport address rather then using the shared cluster transport.

TransportBackloggedConnectionList

String[]

read-only

A list of backlogged connections on the service-dedicated transport

TransportBackloggedConnections

Integer

read-only

The number of backlogged connections on the service-dedicated transport. Any new requests that require the connection are blocked until the backlog is cleared.

TransportConnections

Integer

read-only

The number of maintained connections on the service-dedicated transport. This count may be lower than the member count if some members have not been configured to use the dedicated transport, or it has been identified that there is no advantage in using the dedicated transport for communication with certain members.

TransportReceivedBytes

Long

read-only

The number of bytes that were received by the service-dedicated transport since the last time the statistics were reset

TransportReceivedMessages

Long

read-only

The number of messages that were received by the service-dedicated transport since the last time the statistics were reset

TransportRetainedBytes

Long

read-only

The number of bytes that were retained by the service-dedicated transport and that are awaiting delivery acknowledgment. This memory is allocated outside of the Java garbage collection heap space.

TransportSentBytes

Long

read-only

The number of bytes that were sent by the service-dedicated transport since the last time the statistics were reset

TransportSentMessages

Long

read-only

The number of messages that were sent by the service-dedicated transport since the last time the statistics were reset

Type

String

read-only

The type identifier of the service

Operations

Table A-24 describes the operations for ServiceMBean.

Table A-24 ServiceMBean Operations

Operation Parameters Return Type Description

reportOwnership

fVerbose

String

Reports the partitions that are owned by the service on this node. The fVerbose parameter formats the ownership summary. Valid values are true or false. Setting the parameter to true includes the detailed ownership catalog.

resetStatistics

Not applicable

void

Reset the service statistics

shutdown

Not applicable

void

Stop the service. This is a controlled shutdown, and is preferred to the stop operation.

start

Not applicable

void

Start the service

stop

Not applicable

void

Force the service to stop. Use the shutdown operation for normal service termination.

SimpleStrategyMBean

The SimpleStrategyMBean MBean represents a simple partition assignment strategy and provides operational statistics. Each partitioned service registers a single instance of this managed bean. The MBean is attached to a single instance of the PartitionAssignmentStrategy object which exists on the member that is the distribution coordinator for the service. The associated MBean is not explicitly unregistered, but its name is rebound to a new MBean instance if and when a different service member becomes the distribution coordinator.

The object name of the MBean is:

Coherence:type=PartitionAssignment,service=service name,
responsibility=DistributionCoordinator

Attributes

Table A-25 describes the attributes for SimpleStrategyMBean.

Table A-25 SimpleStrategyMBean Attributes

Attribute Type Access Description

AveragePartitionSizeKB

Long

read-only

The average partition storage size in kilobytes

AverageStorageSizeKB

Long

read-only

The average node storage size in kilobytes

BackupCount

Integer

read-only

The configured number of partition backups to be maintained by the service

CoordinatorId

Integer

read-only

The member identifier of the service node that is the ownership distribution coordinator

FairShareBackup

Integer

read-only

The number of backup partitions per storage-enabled service member that this strategy currently attempts to maintain

FairSharePrimary

Integer

read-only

The number of primary partitions per storage-enabled service member that this strategy currently attempts to maintain

HAStatus

String

read-only

The high availability status for this service. Valid values are:

  • MACHINE-SAFE – The cluster nodes running on a machine can be stopped at once without any data loss.

  • RACK-SAFE – The cluster nodes running on a rack can be stopped at once without any data loss.

  • SITE-SAFE – The cluster nodes running at a sight can be stopped at once without any data loss.

  • NODE-SAFE – A cluster node can be stopped without any data loss.

  • ENDANGERED – Abnormal termination of a cluster node that runs this service can cause data loss.

HATarget

String

read-only

The high availability status that this strategy attempts to achieve. Valid values are the same as the HAStatus attribute.

LastAnalysisTime

Date

read-only

The last time a distribution analysis was performed

MaxLoadNodeId

Integer

read-only

The node identified with the maximum node storage size

MaxPartitionSizeKB

Long

read-only

The maximum partition storage size in kilobytes

MaxStorageSizeKB

Long

read-only

The maximum node storage size in kilobytes

PartitionCount

Integer

read-only

The configured number of partitions for the service

RemainingDistributionCount

Integer

read-only

The number of partition transfers that remain to be completed before the service achieves the goals set by this strategy

ServiceMachineCount

Integer

read-only

The number of machines that host storage-enabled nodes running this service

ServiceNodeCount

Integer

read-only

The number of storage-enabled nodes running this service

ServiceRackCount

Integer

read-only

The number of racks that host storage-enabled nodes running this service

ServiceSiteCount

Integer

read-only

The number of sites that host storage-enabled nodes running this service

StrategyName

String

read-only

The name of the partition assignment strategy that is in use

Operations

Table A-26 describes the operations for SimpleStrategyMBean.

Table A-26 SimpleStrategyMBean Operations

Operation Parameters Return Type Description

reportScheduledDistributions

Boolean fVerbose

String

Report partitions that remain to be transferred to achieve the goals set by this strategy. If the fVerbose parameter is set to true, the report includes details for each scheduled transfer.

StorageManagerMBean

The StorageManagerMBean MBean represents a storage instance for a storage-enabled distributed cache service and provides usage statistics for the storage-enabled cache and also includes statistics for queries. 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 includes zero or more instances of this managed bean depending on the number of configured distributed caches.

The object name of the MBean is:

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

Attributes

Table A-27 describes the attributes for StorageManagerMBean.

Table A-27 StorageManagerMBean Attributes

Attribute Type Access Description

EventInterceptorInfo

String[]

read-only

An array of statistics for live events processed by event interceptors. The statistics include:

  • Interceptors – a list of registered interceptors

  • ExceptionCount – the number of exceptions thrown from the interceptors since the last time the statistics were reset

  • LastException – a stack trace of the last exception thrown from the interceptors

EventsDispatched

Long

read-only

The total number of events that were dispatched by the storage manager since the last time the statistics were reset

EvictionCount

Long

read-only

The number of evictions, from the backing map that is managed by this storage manager, that were caused by entry expiry or insert operations that would make the underlying backing map 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[]

read-only

An array of information for each index that is 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

read-only

The number of inserts into the backing map. In addition to standard inserts that are caused by put and invoke operations or synthetic inserts that are caused by get operations with read-through backing map topology, this counter increments when distribution transfers move resources into the underlying backing map and decrements 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

Integer

read-only

The number of filter-based listeners that is currently registered with the storage manager

ListenerKeyCount

Integer

read-only

The number of key-based listeners that is currently registered with the storage manager

ListenerRegistrations

Long

read-only

The total number of listener registration requests that were processed by the storage manager since the last time the statistics were reset

LocksGranted

Integer

read-only

The number of locks that is currently granted for the portion of the partitioned cache managed by the storage manager. A call to NamedCache.lock() increments the value, while a call to NamedCache.unlock() decrements the value.

LocksPending

Integer

read-only

The number of pending lock requests for the portion of the partitioned cache managed by the storage manager

MaxQueryDescription

String

read-only

A description of the query with the longest duration that exceeds the MaxQueryThresholdMillis attribute since the statistics were last reset

MaxQueryDurationMillis

Long

read-only

The number of milliseconds of the longest running query since the statistics were last reset

MaxQueryThresholdMillis

Long

read/write

A threshold, in milliseconds, for recording queries. The longest query that executes longer than this threshold is reported by the MaxQueryDescription attribute. The default value is 30 ms.

NonOptimizedQueryAverageMillis

Long

read-only

The average duration, in milliseconds, for non-optimized query execution since the cache statistics were last reset

NonOptimizedQueryCount

Long

read-only

The total number of parallel queries that could not be resolved (or that were partially resolved) using indexes since the statistics were last reset

NonOptimizedQueryTotalMillis

Long

read-only

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

OptimizedQueryAverageMillis

Long

read-only

The average duration, in milliseconds, per optimized query execution since the statistics were last reset

OptimizedQueryCount

Long

read-only

The total number of queries that were fully resolved using indexes since the statistics were last reset

OptimizedQueryTotalMillis

Long

read-only

The total execution time, in milliseconds, for queries that were fully resolved using indexes since the statistics were last reset

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

RemoveCount

Long

read-only

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[]

read-only

An array of information for each trigger that is 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 implementation.

Operations

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

TopologyMBean

The TopologyMBean MBean represents federation participants in the context of a topology. A federation topology defines how data is synchronized among federation participants. An instance of this managed bean is registered for each topology being used by a federated cache service.

The object name of the MBean is:

Coherence:type=Federation,subType=Topology,name=topology name nodeId=cluster node id

Attributes

Table A-28 describes the attributes for TopologyMBean.

Table A-28 TopologyMBean Attributes

Attribute Type Access Description

CacheNames

Collection

read-only

The names of the caches using this topology

ParticpantTypes

Map

read-only

The map of participants and their corresponding type

RoleParticipants

Map

read-only

The map of roles and the participants in that role

TopologyType

String

read-only

The topology type

Operations

The TopologyMBean MBean has no operations.

TransactionManagerMBean

The TransactionManagerMBean MBean represents a transaction manager in the transactional framework and provides global transaction manager statics by aggregating service-level statistics from all transaction service instances. A cluster member includes zero or more instances of this managed bean depending on the number of configured transactional caches. Each cluster member has one instance of the transaction manager MBean for each service.

The object name of the MBean is:

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

Note:

For certain transaction manager attributes, the coordinator member for the transaction maintains the count even though multiple members participate in the transaction. For example, a transaction may include modifications to entries stored on multiple members, but the TotalCommitted attribute only increments on the MBean on the member that coordinated the commit of that transaction.

Attributes

Table A-29 describes the attributes for TransactionManagerMBean.

Table A-29 TransactionManagerMBean Attributes

Attribute Type Access Description

CommitTotalMillis

Long

read-only

The cumulative time (in milliseconds) that was spent during the commit phase since the last time statistics were reset

RefreshTime

Date

read-only

The timestamp when this model was last retrieved from a corresponding member. For local servers, it is the local time.

TimeoutMillis

Long

read-only

The transaction timeout value in milliseconds. This value only applies to transactional connections obtained after the value is set. This attribute is currently not supported.

TotalActive

Long

read-only

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. The coordinator member for this transaction maintains the count even though multiple members may have participated in the transaction.

TotalCommitted

Long

read-only

The total number of transactions that have been committed by the transaction manager since the last time the statistics were reset. The coordinator member for this transaction maintains the count even though multiple members may have participated in the transaction.

TotalRecovered

Long

read-only

The total number of transactions that have been recovered by the transaction manager since the last time the statistics were reset. The coordinator member for this transaction maintains the count even though multiple members may have participated in the transaction.

TotalRolledback

Long

read-only

The total number of transactions that have been rolled back by the transaction manager since the last time the statistics were reset. The coordinator member for this transaction maintains the count even though multiple members may have participated in the transaction.

TotalTransactionMillis

Long

read-only

The cumulative time (in milliseconds) that was spent on active transactions

Operations

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