public interface CacheServerMXBean
CacheServer
.
The will be one CacheServerMBean per CacheServer
started in GemFire node.
ObjectName for this MBean is GemFire:service=CacheServer,port={0},type=Member,member={1}
Notification Type | Notification Source | Message |
---|---|---|
gemfire.distributedsystem.cacheserver.client.joined | CacheServer MBean Name | Client joined with Id <Client ID> |
gemfire.distributedsystem.cacheserver.client.left | CacheServer MBean Name | Client crashed with Id <Client ID> |
gemfire.distributedsystem.cacheserver.client.crashed | CacheServer MBean Name | Client left with Id <Client ID> |
Modifier and Type | Method and Description |
---|---|
void |
closeAllContinuousQuery(String regionName)
Deprecated.
This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.
|
void |
closeContinuousQuery(String queryName)
Deprecated.
This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.
|
void |
executeContinuousQuery(String queryName)
Deprecated.
This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.
|
ServerLoadData |
fetchLoadProbe()
Returns the load probe for this CacheServer.
|
long |
getActiveCQCount()
Returns the number of active (currently executing) CQs.
|
String |
getBindAddress()
Returns a string representing the IP address or host name that this CacheServer will listen on.
|
int |
getCapacity()
Returns the capacity (in megabytes) of the client queue.
|
int |
getClientConnectionCount()
Returns the number of sockets accepted and used for client to server messaging.
|
String[] |
getClientIds()
Returns a list of IDs for all connected clients.
|
long |
getClientNotificationAvgLatency()
Returns the average latency for processing client notifications.
|
float |
getClientNotificationRate()
Returns the rate of client notifications.
|
double |
getConnectionLoad()
Returns the load from client to server connections as reported by the load probe installed in
this server.
|
int |
getConnectionThreads()
Returns the current number of threads handling a client connection.
|
String[] |
getContinuousQueryList()
Returns a list of names for all registered CQs.
|
int |
getCurrentClients()
Returns the number of client virtual machines connected.
|
String |
getDiskStoreName()
Returns the name of the disk store that is used for persistence.
|
String |
getEvictionPolicy()
Returns the eviction policy that is executed when the capacity of the client queue is reached.
|
long |
getGetRequestAvgLatency()
Returns the average get request latency.
|
float |
getGetRequestRate()
Returns the rate of get requests.
|
String |
getHostNameForClients()
Returns the name or IP address to pass to the client as the location where the server is
listening.
|
int |
getIndexCount()
Returns the total number of indexes in use by the member.
|
String[] |
getIndexList()
Returns a list of names for all indexes.
|
double |
getLoadPerConnection()
Returns the estimate of how much load is added for each new connection as reported by the load
probe installed in this server.
|
double |
getLoadPerQueue()
Returns the estimate of how much load is added for each new queue as reported by the load probe
installed in this server.
|
long |
getLoadPollInterval()
Returns the frequency (in milliseconds) to poll the load probe on this CacheServer.
|
int |
getMaxConnections()
Returns the maximum allowed client connections.
|
int |
getMaximumMessageCount()
Returns the maximum number of messages that can be enqueued in a client-queue.
|
int |
getMaximumTimeBetweenPings()
Returns the maximum amount of time between client pings.
|
int |
getMaxThreads()
Returns the maximum number of threads allowed in this CacheServer to service client requests.
|
int |
getMessageTimeToLive()
Returns the time (in seconds) after which a message in the client queue will expire.
|
int |
getNumClientNotificationRequests()
Returns the number of cache client notification requests.
|
int |
getNumSubscriptions()
Returns the number of clients who have existing subscriptions.
|
int |
getPort()
Returns the port on which this CacheServer listens for clients.
|
long |
getPutRequestAvgLatency()
Returns the average put request latency.
|
float |
getPutRequestRate()
Returns the rate of put requests.
|
float |
getQueryRequestRate()
Returns the rate of queries.
|
double |
getQueueLoad()
Returns the load from queues as reported by the load probe installed in this server.
|
long |
getRegisteredCQCount()
Returns the number of registered CQs.
|
int |
getSocketBufferSize()
Returns the configured buffer size of the socket connection for this CacheServer.
|
int |
getThreadQueueSize()
Returns the current number of connections waiting for a thread to start processing their
message.
|
int |
getTotalConnectionsTimedOut()
Returns the total number of client connections that timed out and were closed.
|
int |
getTotalFailedConnectionAttempts()
Returns the total number of client connection requests that failed.
|
long |
getTotalIndexMaintenanceTime()
Returns the total time spent updating indexes due to changes in the data.
|
long |
getTotalReceivedBytes()
Returns the total number of bytes received from clients.
|
long |
getTotalSentBytes()
Returns the total number of bytes sent to clients.
|
boolean |
isRunning()
Returns whether or not this CacheServer is running.
|
void |
removeIndex(String indexName)
Remove an index.
|
ClientHealthStatus[] |
showAllClientStats()
Returns health and statistic information for all clients.
|
ClientQueueDetail[] |
showClientQueueDetails()
Shows a list of client with their queue statistics.
|
ClientQueueDetail |
showClientQueueDetails(String clientId)
Shows queue statistics of the given client.
|
ClientHealthStatus |
showClientStats(String clientId)
Returns health and statistic information for the give client id.
|
void |
stopContinuousQuery(String queryName)
Deprecated.
This method is dangerous because it only modifies the target cache server - other
copies of the CQ on other servers are not affected. Using the client side CQ
methods to modify a CQ.
|
int getPort()
String getBindAddress()
int getSocketBufferSize()
int getMaximumTimeBetweenPings()
int getMaxConnections()
int getMaxThreads()
int getMaximumMessageCount()
int getMessageTimeToLive()
long getLoadPollInterval()
String getHostNameForClients()
ServerLoadData fetchLoadProbe()
boolean isRunning()
int getCapacity()
String getEvictionPolicy()
String getDiskStoreName()
int getClientConnectionCount()
int getCurrentClients()
long getGetRequestAvgLatency()
long getPutRequestAvgLatency()
int getTotalConnectionsTimedOut()
int getTotalFailedConnectionAttempts()
int getThreadQueueSize()
int getConnectionThreads()
double getConnectionLoad()
double getLoadPerConnection()
double getQueueLoad()
double getLoadPerQueue()
float getGetRequestRate()
float getPutRequestRate()
long getTotalSentBytes()
long getTotalReceivedBytes()
int getNumClientNotificationRequests()
long getClientNotificationAvgLatency()
float getClientNotificationRate()
long getRegisteredCQCount()
long getActiveCQCount()
float getQueryRequestRate()
int getIndexCount()
String[] getIndexList()
long getTotalIndexMaintenanceTime()
void removeIndex(String indexName) throws Exception
indexName
- Name of the index to be removed.Exception
- if an exception is encountered when removing the indexString[] getContinuousQueryList()
@Deprecated void executeContinuousQuery(String queryName) throws Exception
queryName
- Name of the CQ to execute.Exception
- if an exception is encountered while executing the CQ@Deprecated void stopContinuousQuery(String queryName) throws Exception
queryName
- Name of the CQ to stop.Exception
- if an exception is encountered while stopping the CQ@Deprecated void closeAllContinuousQuery(String regionName) throws Exception
regionName
- Name of the region from which to remove CQs.Exception
- if an exception is encountered while unregistering the CQs@Deprecated void closeContinuousQuery(String queryName) throws Exception
queryName
- Name of the CQ to unregister.Exception
- if an exception is encountered while unregistering the CQString[] getClientIds() throws Exception
Exception
- if an exception is encountered while retrieving the IDsClientHealthStatus showClientStats(String clientId) throws Exception
clientId
- ID of the client for which to retrieve information.Exception
- if an exception is encountered while retrieving the statisticsint getNumSubscriptions()
ClientHealthStatus[] showAllClientStats() throws Exception
Exception
- if an exception is encountered while retrieving the statisticsClientQueueDetail[] showClientQueueDetails() throws Exception
Exception
- if an exception is encountered while retrieving the statisticsClientQueueDetail showClientQueueDetails(String clientId) throws Exception
clientId
- the ID of client which is returned by the attribute ClientIdsException
- if an exception is encountered while retrieving the statistics