JPPF, java, parallel computing, distributed computing, grid computing, parallel, distributed, cluster, grid, cloud, open source, android, .net
JPPF, java, parallel computing, distributed computing, grid computing, parallel, distributed, cluster, grid, cloud, open source, android, .net
JPPF

The open source
grid computing
solution

 Home   About   Features   Download   Documentation   On Github   Forums 

MBeans reference

From JPPF 6.2 Documentation

Jump to: navigation, search

Contents

Main Page > Management and monitoring > MBeans reference


1 MBeans in a JPPF driver

1.1 JobDependencyManagerMBean

  • object name: org.jppf:name=jobDependencyManager,type=driver
  • interface name: JobDependencyManagerMBean
  • description: management interface for the server-side job dependency graphs

1.1.1 Attributes

Graph: the graph of job dependencies

QueuedNodes: the nodes in the job dependency graph, whose corresponding job has arrived in the job queue

NodeIds: the ids of all the nodes currently in the graph

GraphSize: the size - the number of nodes or vertices that represent jobs - of the job dependency grpah

  • type: int
  • readable

AllNodes: all the nodes currently in the job dependency graph

1.1.2 Operations

getNode: get the node with the specified dependency id

JobDependencyNode getNode(String dependencyId)

getQueuedNodes: get the nodes in the job dependency graph, whose corresponding job has arrived in the job queue, filtered by the specified job selector

Collection<JobDependencyNode> getQueuedNodes(JobSelector jobSelector)

1.2 NodeForwardingMBean

  • object name: org.jppf:name=nodeForwardingEx,type=driver
  • interface name: NodeForwardingMBean
  • description: interface for forwarding node management requests and monitoring notfications through a driver

1.2.1 Notifications

  • description: notifications emitted by this MBean wrap actual notifications received from the nodes, then are forwarded to the JMX notification listeners whose node selector matches the emitting nodes
  • type: JPPFNodeForwardingNotification

1.2.2 Operations

shutdown: shutdown the selected nodes, specifying whther to wait until they are no longer executing jobs

ResultsMap<String, Void> shutdown(NodeSelector nodeSelector, Boolean interruptIfRunning)

shutdown: shutdown the selected nodes

ResultsMap<String, Void> shutdown(NodeSelector nodeSelector)

gc: invoke System.gc(} on the selected nodes

ResultsMap<String, Void> gc(NodeSelector nodeSelector)

state: get the latest state information from the selected nodes

restart: restart the selected nodes, specifying whther to wait until they are no longer executing jobs

ResultsMap<String, Void> restart(NodeSelector nodeSelector, Boolean interruptIfRunning)

restart: restart the selected nodes

ResultsMap<String, Void> restart(NodeSelector nodeSelector)

systemInformation: get the system information for the selected nodes

ResultsMap<String, JPPFSystemInformation> systemInformation(NodeSelector nodeSelector)

cancelJob: cancel the job with the specified uuid in the selected nodes

ResultsMap<String, Void> cancelJob(NodeSelector nodeSelector, String jobUuid,
    Boolean requeue)

threadDump: get a thread dump for the selected nodes

ResultsMap<String, ThreadDump> threadDump(NodeSelector nodeSelector)

heapDump: trigger a heap dump on the selected nodes

ResultsMap<String, String> heapDump(NodeSelector nodeSelector)

healthSnapshot: get a JVM health snapshot for the selected nodes

ResultsMap<String, HealthSnapshot> healthSnapshot(NodeSelector nodeSelector)

forwardInvoke: invoke a method on the specified MBean of the selected nodes

ResultsMap<String, E> forwardInvoke(NodeSelector nodeSelector, String mbeanName,
    String methodName, Object[] params,
    String[] signature)

forwardInvoke: invoke an MBean method with no parameter on the selected nodes

ResultsMap<String, E> forwardInvoke(NodeSelector nodeSelector, String mbeanName,
    String methodName)

resetTaskCounter: reset the executed tasks count on the selected nodes to zero

ResultsMap<String, Void> resetTaskCounter(NodeSelector nodeSelector)

setTaskCounter: set the executed tasks count on the selected nodes to a specified value

ResultsMap<String, Void> setTaskCounter(NodeSelector nodeSelector, Integer taskCount)

provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying configuration overrides

ResultsMap<String, Void> provisionSlaveNodes(NodeSelector nodeSelector, int slaves,
    TypedProperties cfgOverrides)

provisionSlaveNodes: make a slave node provisioning request to the selected nodes

ResultsMap<String, Void> provisionSlaveNodes(NodeSelector nodeSelector, int nbSlaves)

provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying whether to wait for slave nodes to be idle before stopping them

ResultsMap<String, Void> provisionSlaveNodes(NodeSelector nodeSelector, int nbSlaves,
    boolean interruptIfRunning)

provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying configuration overrides

ResultsMap<String, Void> provisionSlaveNodes(NodeSelector nodeSelector, int nbSlaves,
    boolean interruptIfRunning, TypedProperties configOverrides)

getNbSlaves: get the number of provisioned slave nodes for the selected nodes

ResultsMap<String, Integer> getNbSlaves(NodeSelector nodeSelector)

getDelegationModel: get the current class loader delegation model for the selected nodes

ResultsMap<String, DelegationModel> getDelegationModel(NodeSelector nodeSelector)

forwardGetAttribute: get the value of an attribute of the specified MBean for each selected node

ResultsMap<String, E> forwardGetAttribute(NodeSelector nodeSelector, String mbeanName,
    String attribute)

forwardSetAttribute: set the value of an attribute of the specified MBean on the selected nodes

ResultsMap<String, Void> forwardSetAttribute(NodeSelector nodeSelector, String mbeanName,
    String attribute, Object value)

updateThreadPoolSize: set the number of processing threads on the selected nodes

ResultsMap<String, Void> updateThreadPoolSize(NodeSelector nodeSelector, Integer size)

updateThreadsPriority: set the priority of the processing threads on the selected nodes

ResultsMap<String, Void> updateThreadsPriority(NodeSelector nodeSelector, Integer newPriority)

updateConfiguration: update the configuration properties of the selected nodes

ResultsMap<String, Void> updateConfiguration(NodeSelector nodeSelector, Map configOverrides,
    Boolean restart)

updateConfiguration: update the configuration properties of the selected nodes

ResultsMap<String, Void> updateConfiguration(NodeSelector nodeSelector, Map configOverrides,
    Boolean restart, Boolean interruptIfRunning)

setDelegationModel: set the class loader delegation model onr the selected nodes

ResultsMap<String, Void> setDelegationModel(NodeSelector nodeSelector, DelegationModel delegationModel)

1.3 DiagnosticsMBean

  • object name: org.jppf:name=diagnostics,type=driver
  • interface name: DiagnosticsMBean
  • description: management and monitoring of the JVM health

1.3.1 Attributes

MonitoringDataProperties: The list of monitoring data properties available in the snapshots

1.3.2 Operations

gc: perform a full garbage collection by calling System.gc()

void gc()

threadDump: get a full thread dump, including detection of deadlocks

ThreadDump threadDump()

cpuLoad: get an approximation of the current CPU load

Double cpuLoad()

heapDump: trigger a heap dump of the JVM

String heapDump()

threadNames: get the names of all live threads in the current JVM

String[] threadNames()

healthSnapshot: get a summarized snapshot of the JVM health

HealthSnapshot healthSnapshot()

hasDeadlock: determine whether a deadlock is detected in the JVM

Boolean hasDeadlock()

memoryInformation: get the current state of the heap and non-heap memory for the JVM

MemoryInformation memoryInformation()

healthSnapshotAsString: get a a string representation of a JVM health snapshot. The returned string contains a set of key / value pairs separated by new lines

String healthSnapshotAsString()

1.4 JPPFDriverAdminMBean

  • object name: org.jppf:name=admin,type=driver
  • interface name: JPPFDriverAdminMBean
  • description: administration of the JPPF server

1.4.1 Attributes

Broadcasting: whether the driver's connection information is broadcast via UDP multicast

  • type: boolean
  • readable / writable

1.4.2 Operations

statistics: get the server statistics

JPPFStatistics statistics()

nbNodes: get the number of selected nodes attached to the driver

Integer nbNodes(NodeSelector nodeSelector)

nbNodes: get the number of nodes attached to the driver

Integer nbNodes()

nodesInformation: get the JMX connection information for the selected nodes attached to the server, possibly including other peer drivers

Collection<JPPFManagementInfo> nodesInformation(NodeSelector nodeSelector, boolean icludePeers)

nodesInformation: get the JMX connection information for the selected nodes attached to the server

Collection<JPPFManagementInfo> nodesInformation(NodeSelector nodeSelector)

nodesInformation: get the JMX connection information for all the nodes attached to the server

Collection<JPPFManagementInfo> nodesInformation()

restartShutdown: perform a shutdown, possibly followed by a restart, of the server, with a specified delay before each

String restartShutdown(Long shutDownDelay, Long restartDelay)

nbIdleNodes: get the number of selected attached nodes currently idle

Integer nbIdleNodes(NodeSelector nodeSelector)

nbIdleNodes: get the number of attached nodes currently idle

Integer nbIdleNodes()

nbIdleNodes: get the number of selected attached nodes currently idle, possibly including other peer drivers

Integer nbIdleNodes(NodeSelector nodeSelector, boolean includePeers)

resetStatistics: reste the server statistics

void resetStatistics()

getActiveState: get the activate state of the selected nodes

Collection<String, Boolean> getActiveState(NodeSelector nodeSelector)

setActiveState: set the active state of the selected nodes

void setActiveState(NodeSelector nodeSelector, boolean active)

changeLoadBalancerSettings: change the load balancer settings

String changeLoadBalancerSettings(String algorithm, Map parameters)

loadBalancerInformation: get the load balancer settings

LoadBalancingInformation loadBalancerInformation()

idleNodesInformation: get the JMX connection information for all the selected idle nodes attached to the server

Collection<JPPFManagementInfo> idleNodesInformation(NodeSelector nodeSelector)

idleNodesInformation: get the JMX connection information for all the idle nodes attached to the server

Collection<JPPFManagementInfo> idleNodesInformation()

toggleActiveState: toggle the activate state of the selected nodes

void toggleActiveState(NodeSelector nodeSelector)

systemInformation: get detailed information on the system where the JPPF server or node is runnning: environement variables, JVM system properties, JPPF configuration, runtime information, storage details, network interfaces, statistics

JPPFSystemInformation systemInformation()

1.5 DriverJobManagementMBean

  • object name: org.jppf:name=jobManagement,type=driver
  • interface name: DriverJobManagementMBean
  • description: the server-side job management interface

1.5.1 Notifications

1.5.2 Attributes

AllJobUuids: the set of uuids for all the jobs currently queued or executing

1.5.3 Operations

updatePriority: update the priority of the job with the specified uuid

void updatePriority(String jobUuid, Integer newPriority)

updatePriority: update the priority of the selected jobs

void updatePriority(JobSelector jobSelector, Integer newPriority)

cancelJob: cancel the job with the specified uuid

void cancelJob(String jobUuid)

resumeJob: resume the job with the specified uuid

void resumeJob(String jobUuid)

suspendJob: suspend the job with the specified uuid

void suspendJob(String jobUuid, Boolean requeue)

updateMaxNodes: update the maximum number of nodes the selected jobs can run on

void updateMaxNodes(JobSelector jobSelector, Integer maxNodes)

updateMaxNodes: update the maximum number of nodes the job with the specified uuid can run on

void updateMaxNodes(String jobUuid, Integer maxNodes)

suspendJobs: suspend the selected jobs

void suspendJobs(JobSelector jobSelector, Boolean requeue)

cancelJobs: cancel the selected jobs

void cancelJobs(JobSelector jobSelector)

resumeJobs: resume the selected jobs

void resumeJobs(JobSelector jobSelector)

updateJobs: update the SLA and/or metadata of the selected jobs

void updateJobs(JobSelector jobSelector, JobSLA sla,
    JobMetadata metadata)

getJobInformation: get the job information for the selected jobs

JobInformation[] getJobInformation(JobSelector jobSelector)

getJobInformation: get an object describing the job with the specified uuid

JobInformation getJobInformation(String jobUuid)

getNodeInformation: get, for the selected jobs, a mapping of job uuid to an object describing the nodes to which the whole or part of each job was dispatched

Map<String, NodeJobInformation[]> getNodeInformation(JobSelector jobSelector)

getNodeInformation: get a list of objects describing the nodes to which the whole or part of a job was dispatched

NodeJobInformation[] getNodeInformation(String jobUuid)

1.6 LoadBalancerPersistenceManagerMBean

  • object name: org.jppf:name=loadBalancerPersistenceManager,type=driver
  • interface name: LoadBalancerPersistenceManagerMBean
  • description: interface for the remote management of a server-side load-balancing persistence store

1.6.1 Attributes

UncompletedOperations: the number of persistence operations, including load, store, delete and list, that have started but not yet completed

  • type: int
  • readable

PersistenceEnabled: wether the load-balancer persistence is enabled

  • type: boolean
  • readable

1.6.2 Operations

delete: delete the specified algorithm state from the specified channel

void delete(String channelID, String algorithm)

listAllChannelsWithAlgorithm: list all the channels that have an entry in the persistence store for the specified algorithm

List<String> listAllChannelsWithAlgorithm(String algorithm)

listAllChannels: list all the channels that have an entry in the persistence store

List<String> listAllChannels()

listAlgorithms: list all the algorithms for which the specified channel has an entry in the persistence store

List<String> listAlgorithms(String channelID)

hasAlgorithm: determine whether the specified channel has an entry for the specified algorithm in the persistence store

boolean hasAlgorithm(String channelID, String algorithm)

deleteAll: delete all entries in the persistece store

void deleteAll()

deleteChannel: delete all entries for the specified channel

void deleteChannel(String channelID)

deleteAlgorithm: delete the specified algorithm state from all the channels that have it

void deleteAlgorithm(String algorithm)

1.7 JPPFNodeConnectionNotifierMBean

  • object name: org.jppf:name=nodeConnectionNotifier,type=driver
  • interface name: JPPFNodeConnectionNotifierMBean
  • description: monitoring of nodes connecting to, or disconnecting from, a JPPF driver

1.7.1 Notifications

  • description: notifications of a node connection or disconnection. Notification.getType() returns either 'CONNECTED' or 'DISCONNECTED'
  • type: Notification
  • user data type: JPPFManagementInfo

2 MBeans in a JPPF node

2.1 DiagnosticsMBean

  • object name: org.jppf:name=diagnostics,type=node
  • interface name: DiagnosticsMBean
  • description: management and monitoring of the JVM health

2.1.1 Attributes

MonitoringDataProperties: The list of monitoring data properties available in the snapshots

2.1.2 Operations

gc: perform a full garbage collection by calling System.gc()

void gc()

threadNames: get the names of all live threads in the current JVM

String[] threadNames()

threadDump: get a full thread dump, including detection of deadlocks

ThreadDump threadDump()

hasDeadlock: determine whether a deadlock is detected in the JVM

Boolean hasDeadlock()

healthSnapshot: get a summarized snapshot of the JVM health

HealthSnapshot healthSnapshot()

heapDump: trigger a heap dump of the JVM

String heapDump()

cpuLoad: get an approximation of the current CPU load

Double cpuLoad()

healthSnapshotAsString: get a a string representation of a JVM health snapshot. The returned string contains a set of key / value pairs separated by new lines

String healthSnapshotAsString()

memoryInformation: get the current state of the heap and non-heap memory for the JVM

MemoryInformation memoryInformation()

2.2 JPPFNodeMaintenanceMBean

  • object name: org.jppf:name=node.maintenance,type=node
  • interface name: JPPFNodeMaintenanceMBean
  • description: maintenance operations on the nodes

2.2.1 Operations

requestResourceCacheReset: request a reset of the resource caches of all the JPPF class loaders maintained by the node

void requestResourceCacheReset()

2.3 NodeConfigNotifierMBean

  • object name: org.jppf:name=config.notifier,type=node
  • interface name: NodeConfigNotifierMBean
  • description: interface listneing for specific configuration changes in a node

2.3.1 Notifications

  • description: notifies of changes to the number of processing threads of a node
  • type: Notification
  • user data: the configuration properties that changed
  • user data type: TypedProperties

2.4 JPPFNodeAdminMBean

  • object name: org.jppf:name=admin,type=node
  • interface name: JPPFNodeAdminMBean
  • description: management and monitoring of a JPPF node

2.4.1 Attributes

DelegationModel: the current class loader delegation model for the node

TaskCounter: reset the node's executed tasks counter to the specified value

2.4.2 Operations

shutdown: shutdown the node, specifying whether to wait for executing tasks to complete

void shutdown(Boolean interruptIfRunning)

shutdown: shutdown the node unconditionally

void shutdown()

state: get the latest state information from the node

updateThreadsPriority: update the priority of all processing threads

void updateThreadsPriority(Integer newPriority)

restart: restart the node unconditionally

void restart()

restart: restart the node, specifying whether to wait for executing tasks to complete

void restart(Boolean interruptIfRunning)

cancelJob: ancel the job with the specified uuid

void cancelJob(String jobUuid, Boolean requeue)

updateThreadPoolSize: set the size of the node's thread pool

void updateThreadPoolSize(Integer poolSize)

updateConfiguration: update the configuration properties of the node

void updateConfiguration(Map configUpdates, Boolean restartNode)

updateConfiguration: update the configuration properties of the node

void updateConfiguration(Map cfgUpdates, Boolean restartNode,
    Boolean interruptIfRunning)

cancelPendingAction: cancel a previous deferred shutdown or restart request, if any

boolean cancelPendingAction()

resetTaskCounter: reset the node's executed tasks counter to zero

void resetTaskCounter()

pendingAction: determine wether a deffered shutdwon or restartd was requested and not yet performed for the node

NodePendingAction pendingAction()

systemInformation: get detailed information on the system where the JPPF server or node is runnning: environement variables, JVM system properties, JPPF configuration, runtime information, storage details, network interfaces, statistics

JPPFSystemInformation systemInformation()

2.5 JPPFNodeTaskMonitorMBean

  • object name: org.jppf:name=task.monitor,type=node
  • interface name: JPPFNodeTaskMonitorMBean
  • description: monitoring of the tasks processing in a node

2.5.1 Notifications

  • description: notifications sent after or during the execution of each task
  • type: TaskExecutionNotification
  • user data: any user-defined data that is sent along with the notification
  • user data type: any type

2.5.2 Attributes

TotalTasksSucessfull: the total number of tasks that executed successfully

TotalTaskCpuTime: the total cpu time used by the tasks in milliseconds

  • type: Long
  • readable

TotalTasksExecuted: the total number of tasks executed by the node

TotalTasksInError: the total number of tasks that ended in error

TotalTaskElapsedTime: the total elapsed time used by the tasks in milliseconds

  • type: Long
  • readable

2.5.3 Operations

reset: reset the statistics maintained by this MBean

void reset()

2.6 JPPFNodeProvisioningMBean

  • object name: org.jppf:name=provisioning,type=node
  • interface name: JPPFNodeProvisioningMBean
  • description: interface for provisioning, managing and monitoring slave nodes

2.6.1 Notifications

2.6.2 Attributes

NbSlaves: the number of slave nodes started by this MBean

  • type: int
  • readable

2.6.3 Operations

provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed

void provisionSlaveNodes(int slaves, TypedProperties configOverrides)

provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed

void provisionSlaveNodes(int slaves, boolean interrupt,
    TypedProperties configgOverrides)

provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed

void provisionSlaveNodes(int slaves)

provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed

void provisionSlaveNodes(int slaves, boolean interruptIfRunning)
Main Page > Management and monitoring > MBeans reference

JPPF Copyright © 2005-2019 JPPF.org Powered by MediaWiki