@MXBeanDescription(value="MBean that provides access to Kernal information.") public interface IgniteMXBean
Modifier and Type | Method and Description |
---|---|
boolean |
active()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.active" instead. |
void |
active(boolean active)
Deprecated.
Use
clusterState(String, boolean) instead. |
void |
clearNodeLocalMap()
Clears node local map.
|
String |
clusterState()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.clusterState" instead. |
void |
clusterState(String state)
Deprecated.
Use
clusterState(String, boolean) instead. |
void |
clusterState(String state,
boolean forceDeactivation)
Changes current cluster state.
|
void |
dumpDebugInfo()
Dumps debug information for the current node.
|
String |
executeTask(String taskName,
String arg)
A shortcut method that executes given task assuming single
java.lang.String argument
and java.lang.String return type. |
String |
getCheckpointSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.checkpointSpiFormatted" instead. |
String |
getCollisionSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.collisionSpiFormatted" instead. |
String |
getCommunicationSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.communicationSpiFormatted" instead. |
String |
getCopyright()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.copyright" instead. |
String |
getCurrentCoordinatorFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.currentCoordinatorFormatted" instead. |
String |
getDeploymentSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.deploymentSpiFormatted" instead. |
String |
getDiscoverySpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.discoverySpiFormatted" instead. |
String |
getEventStorageSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.eventStorageSpiFormatted" instead. |
String |
getExecutorServiceFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.executorServiceFormatted" instead. |
String |
getFailoverSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.failoverSpiFormatted" instead. |
String |
getFullVersion()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.fullVersion" instead. |
String |
getGridLoggerFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.gridLoggerFormatted" instead. |
String |
getIgniteHome()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.igniteHome" instead. |
String |
getInstanceName()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.InstanceName" instead. |
String |
getJdkInformation()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.jdkInformation" instead. |
List<String> |
getLifecycleBeansFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.lifecycleBeansFormatted" instead. |
String |
getLoadBalancingSpiFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.loadBalancingSpiFormatted" instead. |
UUID |
getLocalNodeId()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.localNodeId" instead. |
Map<Long,Long> |
getLongJVMPauseLastEvents()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.longJVMPauseLastEvents" instead. |
long |
getLongJVMPausesCount()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.longJVMPausesCount" instead. |
long |
getLongJVMPausesTotalDuration()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.longJVMPausesTotalDuration" instead. |
String |
getMBeanServerFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.mBeanServerFormatted" instead. |
String |
getOsInformation()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.osInformation" instead. |
String |
getOsUser()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.osUser" instead. |
long |
getStartTimestamp()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.startTimestamp" instead. |
String |
getStartTimestampFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.startTimestampFormatted" instead. |
long |
getUpTime()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.upTime" instead. |
String |
getUpTimeFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.uptimeFormatted" instead. |
List<String> |
getUserAttributesFormatted()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.userAttributesFormatted" instead. |
String |
getVmName()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.VmName" instead. |
boolean |
isNodeInBaseline()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.isNodeInBaseline" instead. |
boolean |
isPeerClassLoadingEnabled()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.isPeerClassLoadingEnabled" instead. |
boolean |
isRebalanceEnabled()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.isRebalanceEnabled" instead. |
long |
lastClusterStateChangeTime()
Deprecated.
Check the
ReadOnlyMetricRegistry with "name=ignite.lastClusterStateChangeTime" instead. |
boolean |
pingNode(String nodeId)
Pings node with given node ID to see whether it is alive.
|
boolean |
pingNodeByAddress(String host)
Pings node with given host name to see if it is alive.
|
void |
printLastErrors()
Prints errors.
|
void |
rebalanceEnabled(boolean rebalanceEnabled)
Enable or disable cache partition rebalance per node.
|
boolean |
removeCheckpoint(String key)
This method allows manually remove the checkpoint with given
key . |
void |
runIoTest(long warmup,
long duration,
int threads,
long maxLatency,
int rangesCnt,
int payLoadSize,
boolean procFromNioThread)
Runs IO latency test against all remote server nodes in cluster.
|
void |
undeployTaskFromGrid(String taskName)
Makes the best attempt to undeploy a task from the whole grid.
|
static final String FULL_VER_DESC
static final String COPYRIGHT_DESC
static final String START_TIMESTAMP_FORMATTED_DESC
static final String IS_REBALANCE_ENABLED_DESC
static final String UPTIME_FORMATTED_DESC
static final String START_TIMESTAMP_DESC
static final String UPTIME_DESC
static final String LONG_JVM_PAUSES_CNT_DESC
static final String LONG_JVM_PAUSES_TOTAL_DURATION_DESC
static final String LONG_JVM_PAUSE_LAST_EVENTS_DESC
static final String USER_ATTRS_FORMATTED_DESC
static final String GRID_LOG_FORMATTED_DESC
static final String EXECUTOR_SRVC_FORMATTED_DESC
static final String IGNITE_HOME_DESC
static final String MBEAN_SERVER_FORMATTED_DESC
static final String LOC_NODE_ID_DESC
static final String IS_PEER_CLS_LOADING_ENABLED_DESC
static final String LIFECYCLE_BEANS_FORMATTED_DESC
static final String ACTIVE_DESC
static final String DISCOVERY_SPI_FORMATTED_DESC
static final String COMMUNICATION_SPI_FORMATTED_DESC
static final String DEPLOYMENT_SPI_FORMATTED_DESC
static final String CHECKPOINT_SPI_FORMATTED_DESC
static final String COLLISION_SPI_FORMATTED_DESC
static final String EVT_STORAGE_SPI_FORMATTED_DESC
static final String FAILOVER_SPI_FORMATTED_DESC
static final String LOAD_BALANCING_SPI_FORMATTED_DESC
static final String OS_INFO_DESC
static final String JDK_INFO_DESC
static final String OS_USER_DESC
static final String VM_NAME_DESC
static final String INSTANCE_NAME_DESC
static final String CUR_COORDINATOR_FORMATTED_DESC
static final String IS_NODE_BASELINE_DESC
static final String LAST_CLUSTER_STATE_CHANGE_TIME_DESC
static final String CLUSTER_STATE_DESC
static final String READ_ONLY_MODE_DESC
static final String READ_ONLY_MODE_DURATION_DESC
@Deprecated @MXBeanDescription(value="String presentation of the Ignite version.") String getFullVersion()
ReadOnlyMetricRegistry
with "name=ignite.fullVersion" instead.@Deprecated @MXBeanDescription(value="Copyright statement for Ignite product.") String getCopyright()
ReadOnlyMetricRegistry
with "name=ignite.copyright" instead.@Deprecated @MXBeanDescription(value="Start timestamp of the kernal.") String getStartTimestampFormatted()
ReadOnlyMetricRegistry
with "name=ignite.startTimestampFormatted" instead.@Deprecated @MXBeanDescription(value="Rebalance enabled flag.") boolean isRebalanceEnabled()
ReadOnlyMetricRegistry
with "name=ignite.isRebalanceEnabled" instead.@MXBeanParametersDescriptions(value={"Enable cache partitions rebalance on node.","Disable cache partitions rebalance on node."}) void rebalanceEnabled(boolean rebalanceEnabled)
rebalanceEnabled
- If true
then set rebalance to enabled state.@Deprecated @MXBeanDescription(value="String presentation of up-time for the kernal.") String getUpTimeFormatted()
ReadOnlyMetricRegistry
with "name=ignite.uptimeFormatted" instead.@Deprecated @MXBeanDescription(value="Start timestamp of the kernal.") long getStartTimestamp()
ReadOnlyMetricRegistry
with "name=ignite.startTimestamp" instead.@Deprecated @MXBeanDescription(value="Up-time of the kernal.") long getUpTime()
ReadOnlyMetricRegistry
with "name=ignite.upTime" instead.@Deprecated @MXBeanDescription(value="Long JVM pauses count.") long getLongJVMPausesCount()
ReadOnlyMetricRegistry
with "name=ignite.longJVMPausesCount" instead.@Deprecated @MXBeanDescription(value="Long JVM pauses total duration.") long getLongJVMPausesTotalDuration()
ReadOnlyMetricRegistry
with "name=ignite.longJVMPausesTotalDuration" instead.@Deprecated @MXBeanDescription(value="Long JVM pause last events.") Map<Long,Long> getLongJVMPauseLastEvents()
ReadOnlyMetricRegistry
with "name=ignite.longJVMPauseLastEvents" instead.@Deprecated @MXBeanDescription(value="Collection of formatted user-defined attributes added to this node.") List<String> getUserAttributesFormatted()
ReadOnlyMetricRegistry
with "name=ignite.userAttributesFormatted" instead.Note that grid will add all System properties and environment properties to grid node attributes also. SPIs may also add node attributes that are used for SPI implementation.
@Deprecated @MXBeanDescription(value="Formatted instance of logger that is in grid.") String getGridLoggerFormatted()
ReadOnlyMetricRegistry
with "name=ignite.gridLoggerFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured thread pool that is used in grid.") String getExecutorServiceFormatted()
ReadOnlyMetricRegistry
with "name=ignite.executorServiceFormatted" instead.@Deprecated @MXBeanDescription(value="Ignite installation home folder.") String getIgniteHome()
ReadOnlyMetricRegistry
with "name=ignite.igniteHome" instead.@Deprecated @MXBeanDescription(value="Formatted instance of MBean server instance.") String getMBeanServerFormatted()
ReadOnlyMetricRegistry
with "name=ignite.mBeanServerFormatted" instead.@Deprecated @MXBeanDescription(value="Unique identifier for this node within grid.") UUID getLocalNodeId()
ReadOnlyMetricRegistry
with "name=ignite.localNodeId" instead.@Deprecated @MXBeanDescription(value="Whether or not peer class loading (a.k.a. P2P class loading) is enabled.") boolean isPeerClassLoadingEnabled()
ReadOnlyMetricRegistry
with "name=ignite.isPeerClassLoadingEnabled" instead.true
if peer class loading is enabled, false
otherwise. Default value is true
.
When peer class loading is enabled and task is not deployed on local node, local node will try to load classes from the node that initiated task execution. This way, a task can be physically deployed only on one node and then internally penetrate to all other nodes.
true
if peer class loading is enabled, false
otherwise.@Deprecated @MXBeanDescription(value="String representation of lifecycle beans.") List<String> getLifecycleBeansFormatted()
ReadOnlyMetricRegistry
with "name=ignite.lifecycleBeansFormatted" instead.toString()
representation of of lifecycle beans configured
with Ignite.toString()
representation of all lifecycle beans configured
with Ignite.@MXBeanDescription(value="This method allows manually remove the checkpoint with given key. Return true if specified checkpoint was indeed removed, false otherwise.") boolean removeCheckpoint(@MXBeanParameter(name="key",description="Checkpoint key to remove.") String key)
key
.key
- Checkpoint key.true
if specified checkpoint was indeed removed, false
otherwise.@MXBeanDescription(value="Pings node with given node ID to see whether it is alive. Returns whether or not node is alive.") boolean pingNode(@MXBeanParameter(name="nodeId",description="String presentation of node ID. See java.util.UUID class for details.") String nodeId)
nodeId
- String presentation of node ID. See UUID.fromString(String)
for
details on string formatting.@Deprecated @MXBeanDescription(value="Execute activate or deactivate process.") @MXBeanParametersNames(value="active") void active(boolean active) throws JMException
clusterState(String, boolean)
instead.NOTE: Deactivation clears in-memory caches (without persistence) including the system caches.
active
- Activate/DeActivate flag.JMException
- if deactivation is forbidden or stopped.@Deprecated @MXBeanDescription(value="Checks Ignite grid is active or is not active.") boolean active()
ReadOnlyMetricRegistry
with "name=ignite.active" instead.False
.True
if grid is active. False
If grid is not active.@MXBeanDescription(value="Makes the best attempt to undeploy a task from the whole grid.") void undeployTaskFromGrid(@MXBeanParameter(name="taskName",description="Name of the task to undeploy.") String taskName) throws JMException
Note that Ignite maintains internal versions for grid tasks in case of redeployment. This method will attempt to undeploy all versions on the grid task with given name.
taskName
- Name of the task to undeploy. If task class has ComputeTaskName
annotation,
then task was deployed under a name specified within annotation. Otherwise, full
class name should be used as task's name.JMException
- Thrown if undeploy failed.@MXBeanDescription(value="A shortcut method that executes given task assuming single String argument and String return type. Returns Task return value (assumed of String type).") String executeTask(@MXBeanParameter(name="taskName",description="Name of the task to execute.") String taskName, @MXBeanParameter(name="arg",description="Single task execution argument (can be null).") String arg) throws JMException
java.lang.String
argument
and java.lang.String
return type.taskName
- Name of the task to execute.arg
- Single task execution argument (can be null
).java.lang.String
type).JMException
- Thrown in case when execution failed.@MXBeanDescription(value="Pings node with given host name to see if it is alive. Returns whether or not node is alive.") boolean pingNodeByAddress(@MXBeanParameter(name="host",description="Host name or IP address of the node to ping.") String host) throws JMException
host
- Host name or IP address of the node to ping.JMException
- When ping failed.@Deprecated @MXBeanDescription(value="Formatted instance of configured discovery SPI implementation.") String getDiscoverySpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.discoverySpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured SPI communication implementation.") String getCommunicationSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.communicationSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured deployment SPI implementation.") String getDeploymentSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.deploymentSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of configured checkpoint SPI implementation.") String getCheckpointSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.checkpointSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of configured collision SPI implementations.") String getCollisionSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.collisionSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured event SPI implementation.") String getEventStorageSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.eventStorageSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured failover SPI implementations.") String getFailoverSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.failoverSpiFormatted" instead.@Deprecated @MXBeanDescription(value="Formatted instance of fully configured load balancing SPI implementations.") String getLoadBalancingSpiFormatted()
ReadOnlyMetricRegistry
with "name=ignite.loadBalancingSpiFormatted" instead.@Deprecated @MXBeanDescription(value="OS information.") String getOsInformation()
ReadOnlyMetricRegistry
with "name=ignite.osInformation" instead.@Deprecated @MXBeanDescription(value="JDK information.") String getJdkInformation()
ReadOnlyMetricRegistry
with "name=ignite.jdkInformation" instead.@Deprecated @MXBeanDescription(value="OS user name.") String getOsUser()
ReadOnlyMetricRegistry
with "name=ignite.osUser" instead.@Deprecated @MXBeanDescription(value="VM name.") String getVmName()
ReadOnlyMetricRegistry
with "name=ignite.VmName" instead.@Deprecated @MXBeanDescription(value="Optional kernal instance name.") String getInstanceName()
ReadOnlyMetricRegistry
with "name=ignite.InstanceName" instead.null
.@MXBeanDescription(value="Prints last suppressed errors.") void printLastErrors()
@MXBeanDescription(value="Dumps debug information for the current node.") void dumpDebugInfo()
@Deprecated @MXBeanDescription(value="Formatted properties of current coordinator.") String getCurrentCoordinatorFormatted()
ReadOnlyMetricRegistry
with "name=ignite.currentCoordinatorFormatted" instead.@Deprecated @MXBeanDescription(value="Baseline node flag.") boolean isNodeInBaseline()
ReadOnlyMetricRegistry
with "name=ignite.isNodeInBaseline" instead.@MXBeanDescription(value="Runs IO latency test against all remote server nodes in cluster.") void runIoTest(@MXBeanParameter(name="warmup",description="Warmup duration (millis).") long warmup, @MXBeanParameter(name="duration",description="Test duration (millis).") long duration, @MXBeanParameter(name="threads",description="Threads count.") int threads, @MXBeanParameter(name="maxLatency",description="Maximum latency expected (nanos).") long maxLatency, @MXBeanParameter(name="rangesCnt",description="Ranges count for histogram.") int rangesCnt, @MXBeanParameter(name="payLoadSize",description="Payload size (bytes).") int payLoadSize, @MXBeanParameter(name="procFromNioThread",description="Process requests in NIO-threads flag.") boolean procFromNioThread)
warmup
- Warmup duration in milliseconds.duration
- Test duration in milliseconds.threads
- Thread count.maxLatency
- Max latency in nanoseconds.rangesCnt
- Ranges count in resulting histogram.payLoadSize
- Payload size in bytes.procFromNioThread
- True
to process requests in NIO threads.@MXBeanDescription(value="Clears local node map.") void clearNodeLocalMap()
@Deprecated @MXBeanDescription(value="Checks cluster state.") String clusterState()
ReadOnlyMetricRegistry
with "name=ignite.clusterState" instead.ClusterState
.@Deprecated @MXBeanDescription(value="Changes current cluster state.") void clusterState(@MXBeanParameter(name="state",description="New cluster state.") String state) throws JMException
clusterState(String, boolean)
instead.NOTE: Deactivation clears in-memory caches (without persistence) including the system caches.
state
- String representation of new cluster state.JMException
- if deactivation is forbidden or stopped.@MXBeanDescription(value="Changes current cluster state.") void clusterState(@MXBeanParameter(name="state",description="New cluster state.") String state, @MXBeanParameter(name="forceDeactivation",description="If true, cluster deactivation will be forced.") boolean forceDeactivation) throws JMException
NOTE: Deactivation clears in-memory caches (without persistence) including the system caches.
state
- String representation of new cluster state.forceDeactivation
- If true
, cluster deactivation will be forced.JMException
- if deactivation is forbidden or stopped.@Deprecated @MXBeanDescription(value="Unix time of last cluster state change operation.") long lastClusterStateChangeTime()
ReadOnlyMetricRegistry
with "name=ignite.lastClusterStateChangeTime" instead.
Follow @ApacheIgnite
Ignite Database and Caching Platform : ver. 2.16.0 Release Date : December 15 2023