MBeans reference
From JPPF 6.2 Documentation
|
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
- type: JobDependencyGraph
- readable
QueuedNodes: the nodes in the job dependency graph, whose corresponding job has arrived in the job queue
- type: Collection<JobDependencyNode>
- readable
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
- type: Collection<JobDependencyNode>
- readable
1.1.2 Operations
getNode: get the node with the specified dependency id
getQueuedNodes: get the nodes in the job dependency graph, whose corresponding job has arrived in the job queue, filtered by the specified job selector
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
shutdown: shutdown the selected nodes
gc: invoke System.gc(} on the selected nodes
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
restart: restart the selected nodes
systemInformation: get the system information for the selected nodes
cancelJob: cancel the job with the specified uuid in the selected nodes
threadDump: get a thread dump for the selected nodes
heapDump: trigger a heap dump on the selected nodes
healthSnapshot: get a JVM health snapshot for the selected nodes
forwardInvoke: invoke a method on the specified MBean of the selected nodes
String methodName, Object[] params,
String[] signature)
forwardInvoke: invoke an MBean method with no parameter on the selected nodes
resetTaskCounter: reset the executed tasks count on the selected nodes to zero
setTaskCounter: set the executed tasks count on the selected nodes to a specified value
provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying configuration overrides
TypedProperties cfgOverrides)
provisionSlaveNodes: make a slave node provisioning request to the selected nodes
provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying whether to wait for slave nodes to be idle before stopping them
boolean interruptIfRunning)
provisionSlaveNodes: make a slave node provisioning request to the selected nodes, specifying configuration overrides
boolean interruptIfRunning, TypedProperties configOverrides)
getNbSlaves: get the number of provisioned slave nodes for the selected nodes
getDelegationModel: get the current class loader delegation model for the selected nodes
forwardGetAttribute: get the value of an attribute of the specified MBean for each selected node
String attribute)
forwardSetAttribute: set the value of an attribute of the specified MBean on the selected nodes
String attribute, Object value)
updateThreadPoolSize: set the number of processing threads on the selected nodes
updateThreadsPriority: set the priority of the processing threads on the selected nodes
updateConfiguration: update the configuration properties of the selected nodes
Boolean restart)
updateConfiguration: update the configuration properties of the selected nodes
Boolean restart, Boolean interruptIfRunning)
setDelegationModel: set the class loader delegation model onr the selected nodes
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
- type: List<JPPFProperty<?>>
- readable
1.3.2 Operations
gc: perform a full garbage collection by calling System.gc()
threadDump: get a full thread dump, including detection of deadlocks
cpuLoad: get an approximation of the current CPU load
heapDump: trigger a heap dump of the JVM
threadNames: get the names of all live threads in the current JVM
healthSnapshot: get a summarized snapshot of the JVM health
hasDeadlock: determine whether a deadlock is detected in the JVM
memoryInformation: get the current state of the heap and non-heap memory for the JVM
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
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
nbNodes: get the number of selected nodes attached to the driver
nbNodes: get the number of nodes attached to the driver
nodesInformation: get the JMX connection information for the selected nodes attached to the server, possibly including other peer drivers
nodesInformation: get the JMX connection information for the selected nodes attached to the server
nodesInformation: get the JMX connection information for all the nodes attached to the server
restartShutdown: perform a shutdown, possibly followed by a restart, of the server, with a specified delay before each
nbIdleNodes: get the number of selected attached nodes currently idle
nbIdleNodes: get the number of attached nodes currently idle
nbIdleNodes: get the number of selected attached nodes currently idle, possibly including other peer drivers
resetStatistics: reste the server statistics
getActiveState: get the activate state of the selected nodes
setActiveState: set the active state of the selected nodes
changeLoadBalancerSettings: change the load balancer settings
loadBalancerInformation: get the load balancer settings
idleNodesInformation: get the JMX connection information for all the selected idle nodes attached to the server
idleNodesInformation: get the JMX connection information for all the idle nodes attached to the server
toggleActiveState: toggle the activate state of the selected nodes
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
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
- description: notification on the status of a job
- type: JobNotification
1.5.2 Attributes
AllJobUuids: the set of uuids for all the jobs currently queued or executing
- type: String[]
- readable
1.5.3 Operations
updatePriority: update the priority of the job with the specified uuid
updatePriority: update the priority of the selected jobs
cancelJob: cancel the job with the specified uuid
resumeJob: resume the job with the specified uuid
suspendJob: suspend the job with the specified uuid
updateMaxNodes: update the maximum number of nodes the selected jobs can run on
updateMaxNodes: update the maximum number of nodes the job with the specified uuid can run on
suspendJobs: suspend the selected jobs
cancelJobs: cancel the selected jobs
resumeJobs: resume the selected jobs
updateJobs: update the SLA and/or metadata of the selected jobs
getJobInformation: get the job information for the selected jobs
getJobInformation: get an object describing the job with the specified uuid
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
getNodeInformation: get a list of objects describing the nodes to which the whole or part of a job was dispatched
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
listAllChannelsWithAlgorithm: list all the channels that have an entry in the persistence store for the specified algorithm
listAllChannels: list all the channels that have an entry in the persistence store
listAlgorithms: list all the algorithms for which the specified channel has an entry in the persistence store
hasAlgorithm: determine whether the specified channel has an entry for the specified algorithm in the persistence store
deleteAll: delete all entries in the persistece store
deleteChannel: delete all entries for the specified channel
deleteAlgorithm: delete the specified algorithm state from all the channels that have it
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
- type: List<JPPFProperty<?>>
- readable
2.1.2 Operations
gc: perform a full garbage collection by calling System.gc()
threadNames: get the names of all live threads in the current JVM
threadDump: get a full thread dump, including detection of deadlocks
hasDeadlock: determine whether a deadlock is detected in the JVM
healthSnapshot: get a summarized snapshot of the JVM health
heapDump: trigger a heap dump of the JVM
cpuLoad: get an approximation of the current CPU load
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
memoryInformation: get the current state of the heap and non-heap memory for the JVM
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
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
- type: DelegationModel
- readable / writable
TaskCounter: reset the node's executed tasks counter to the specified value
- type: Integer
- writable
2.4.2 Operations
shutdown: shutdown the node, specifying whether to wait for executing tasks to complete
shutdown: shutdown the node unconditionally
state: get the latest state information from the node
updateThreadsPriority: update the priority of all processing threads
restart: restart the node unconditionally
restart: restart the node, specifying whether to wait for executing tasks to complete
cancelJob: ancel the job with the specified uuid
updateThreadPoolSize: set the size of the node's thread pool
updateConfiguration: update the configuration properties of the node
updateConfiguration: update the configuration properties of the node
cancelPendingAction: cancel a previous deferred shutdown or restart request, if any
resetTaskCounter: reset the node's executed tasks counter to zero
pendingAction: determine wether a deffered shutdwon or restartd was requested and not yet performed for the node
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
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
- type: Integer
- readable
TotalTaskCpuTime: the total cpu time used by the tasks in milliseconds
- type: Long
- readable
TotalTasksExecuted: the total number of tasks executed by the node
- type: Integer
- readable
TotalTasksInError: the total number of tasks that ended in error
- type: Integer
- readable
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
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
- description: notification that a slave node has started or stopped
- type: Notification
- user data type: JPPFProvisioningInfo
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
provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed
TypedProperties configgOverrides)
provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed
provisionSlaveNodes: provision the specified number of slave nodes, starting new ones or stopping existing ones as needed
Main Page > Management and monitoring > MBeans reference |