NodeAgent (Apache UIMA DUCC: uima-ducc-agent 2.2.0 API)

java.lang.Object
- org.apache.uima.ducc.common.component.AbstractDuccComponent
- - org.apache.uima.ducc.agent.NodeAgent

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, Agent, ProcessLifecycleObserver, ProcessLifecycleController, org.apache.uima.ducc.common.component.AbstractDuccComponentMBean, org.apache.uima.ducc.common.component.DuccComponent, org.apache.uima.ducc.common.component.DuccLifecycle
```
public class NodeAgent
extends org.apache.uima.ducc.common.component.AbstractDuccComponent
implements Agent, ProcessLifecycleObserver
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class NodeAgent.ProcessMemoryUsageRoute
Process resident memory collector routes.
- Nested classes/interfaces inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent
  org.apache.uima.ducc.common.component.AbstractDuccComponent.AdminEventProcessor, org.apache.uima.ducc.common.component.AbstractDuccComponent.ErrorProcessor

Nested Classes
Modifier and Type	Class and Description
`class`	`NodeAgent.ProcessMemoryUsageRoute` Process resident memory collector routes.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`cgroupFailureReason`
`CGroupsManager`	`cgroupsManager`
`AgentConfiguration`	`configurationFactory`
`int`	`cpuClockRate`
`boolean`	`excludeAPs`
`static AtomicLong`	`logCounter`
`static org.apache.uima.ducc.common.utils.DuccLogger`	`logger`
`org.apache.uima.ducc.common.Node`	`node`
`int`	`numProcessors`
`int`	`pageSize`
`boolean`	`pageSizeFetched`
`static String`	`ProcessStateUpdatePort`
`boolean`	`receivedDuccState`
`int`	`shareQuantum`
`static int`	`SIGKILL`
`static int`	`SIGTERM`
`boolean`	`useCgroups`
`boolean`	`virtualAgent`

Fields inherited from interface org.apache.uima.ducc.agent.Agent
COMPONENT_NAME, DUCC_NODE_METRICS_ENDPOINT

Constructor Summary

Constructors
Constructor and Description
`NodeAgent()` Ctor used exclusively for black-box testing of this class.
`NodeAgent(org.apache.uima.ducc.common.NodeIdentity ni)`
`NodeAgent(org.apache.uima.ducc.common.NodeIdentity nodeIdentity, Launcher launcher, org.apache.camel.CamelContext context, AgentConfiguration factory)` C'tor for dependecy injection

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`copyAllUserReservations(TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo> map)`
`Object`	`deepCopy(Object original)`
`void`	`doStartProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine, org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info, org.apache.uima.ducc.common.utils.id.DuccId workDuccId)`
`void`	`doStopProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)`
`boolean`	`duccLingExists()`
`void`	`duccLingExists(boolean duccLingExists)`
`Future<?>`	`getDeployedJPFuture(org.apache.uima.ducc.common.utils.id.IDuccId duccId)`
`org.apache.uima.ducc.transport.dispatcher.DuccEventDispatcher`	`getEventDispatcherForRemoteProcess()`
`AgentEventListener`	`getEventListener()`
`org.apache.uima.ducc.common.NodeIdentity`	`getIdentity()`
`HashMap<org.apache.uima.ducc.common.utils.id.DuccId,org.apache.uima.ducc.transport.event.common.IDuccProcess>`	`getInventoryCopy()` Returns deep copy (by way of java serialization) of the Agents inventory.
`HashMap<org.apache.uima.ducc.common.utils.id.DuccId,org.apache.uima.ducc.transport.event.common.IDuccProcess>`	`getInventoryRef()` Returns shallow copy of the Agent's inventory
`long`	`getLastORSequence()`
`org.apache.uima.ducc.common.utils.DuccLogger`	`getLogger()`
`org.apache.uima.ducc.common.Node`	`getNodeInfo()`
`int`	`getNodeProcessors()`
`int`	`getNodeTotalNumberOfShares()`
`int`	`getOSClockRate()`
`int`	`getOSPageSize()`
`RogueProcessReaper`	`getRogueProcessReaper()`
`List<org.apache.uima.ducc.common.utils.id.DuccId>`	`getUserReservations(String uid)`
`void`	`handleAdminEvent(org.apache.uima.ducc.common.admin.event.DuccAdminEvent event)`
`void`	`interruptThreadInWaitFor(String pid)`
`boolean`	`isManagedProcess(Set<NodeUsersCollector.ProcessInfo> processList, NodeUsersCollector.ProcessInfo cpi)`
`boolean`	`isRogueProcess(String uid, Set<NodeUsersCollector.ProcessInfo> processList, NodeUsersCollector.ProcessInfo cpi)`
`void`	`killProcessDueToLowSwapSpace(long minSwapThreshold)` Called when swap space on a node reached minimum as defined by ducc.node.min.swap.threshold in ducc.properties.
`static void`	`lock()`
`static void`	`main(String[] args)` Called when an Agent receives self dispatched Ping message.
`void`	`onJPInitTimeout(org.apache.uima.ducc.transport.event.common.IDuccProcess process, long timeout)`
`void`	`onProcessExit(org.apache.uima.ducc.transport.event.common.IDuccProcess process)` Called when a process exits.
`void`	`purgeProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)` Remove given process from Agent's inventory
`void`	`reconcileProcessStateAndTakeAction(ProcessLifecycleController lifecycleController, org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine, org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info, org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment, org.apache.uima.ducc.common.utils.id.DuccId workDuccId)` Reconciles agent inventory with job processes sent by PM
`boolean`	`runWithDuccLing()`
`void`	`runWithDuccLing(boolean runWithDuccLing)`
`void`	`setAgentEventListener(AgentEventListener listener)`
`void`	`setNodeInfo(org.apache.uima.ducc.common.Node node)`
`void`	`setReservations(List<org.apache.uima.ducc.transport.event.common.DuccUserReservation> reserves)` Copies reservations sent by the PM.
`void`	`shutdown(String reason)`
`void`	`start(org.apache.uima.ducc.common.main.DuccService service)`
`void`	`startProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine, org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info, org.apache.uima.ducc.common.utils.id.DuccId workDuccId, org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment)` Called when Agent receives request to start a process.
`void`	`stop()`
`void`	`stopProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)` Called when Agent receives request to stop a process.
`void`	`takeDownProcessWithNoJob(ProcessLifecycleController lifecycleController, List<org.apache.uima.ducc.transport.event.common.IDuccJobDeployment> jobDeploymentList)` Stops any process that is in agent's inventory but not in provided job list sent by the PM.
`static void`	`unlock()`
`void`	`updateProcessStatus(org.apache.uima.ducc.transport.event.ProcessStateUpdateDuccEvent duccEvent)` Called when UIMA AS service wrapper sends an update when a process status changes.
`boolean`	`userHasReservation(String uid)`

Methods inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent
adjustTransportEndpoint, cleanup, getContext, getLogLevel, getProcessJmxUrl, handleUncaughtException, handleUncaughtException, isStopping, loadProperties, onDuccAdminKillEvent, reloadProperties, setContext, setLogLevel, setLogLevel, start, startJmxAgent, uncaughtException, validateAdministrator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static org.apache.uima.ducc.common.utils.DuccLogger logger

ProcessStateUpdatePort

public static final String ProcessStateUpdatePort

See Also:: Constant Field Values

SIGKILL
```
public static int SIGKILL
```

SIGTERM
```
public static int SIGTERM
```

logCounter
```
public static AtomicLong logCounter
```

cgroupFailureReason

public static String cgroupFailureReason

configurationFactory

public AgentConfiguration configurationFactory

useCgroups
```
public volatile boolean useCgroups
```

cgroupsManager
```
public CGroupsManager cgroupsManager
```

node

public org.apache.uima.ducc.common.Node node

excludeAPs
```
public volatile boolean excludeAPs
```

shareQuantum
```
public int shareQuantum
```

virtualAgent
```
public boolean virtualAgent
```

pageSizeFetched
```
public boolean pageSizeFetched
```

pageSize
```
public int pageSize
```

cpuClockRate
```
public int cpuClockRate
```

numProcessors
```
public int numProcessors
```

receivedDuccState

public volatile boolean receivedDuccState

Constructor Detail

NodeAgent
```
public NodeAgent()
```
Ctor used exclusively for black-box testing of this class.

NodeAgent

public NodeAgent(org.apache.uima.ducc.common.NodeIdentity ni)

NodeAgent

public NodeAgent(org.apache.uima.ducc.common.NodeIdentity nodeIdentity,
         Launcher launcher,
         org.apache.camel.CamelContext context,
         AgentConfiguration factory)
          throws Exception

C'tor for dependecy injection

Parameters:: nodeIdentity - - this Agent's identity; launcher - - component to launch processes; context - - camel context
Throws:: Exception

Method Detail

getLastORSequence
```
public long getLastORSequence()
```

getEventListener

public AgentEventListener getEventListener()

setAgentEventListener

public void setAgentEventListener(AgentEventListener listener)

getNodeProcessors
```
public int getNodeProcessors()
```

getOSPageSize
```
public int getOSPageSize()
```
Specified by:

getOSPageSize in interface Agent

getOSClockRate
```
public int getOSClockRate()
```

setNodeInfo

public void setNodeInfo(org.apache.uima.ducc.common.Node node)

getNodeInfo

public org.apache.uima.ducc.common.Node getNodeInfo()

getNodeTotalNumberOfShares

public int getNodeTotalNumberOfShares()

start
```
public void start(org.apache.uima.ducc.common.main.DuccService service)
           throws Exception
```
Specified by:

start in interface org.apache.uima.ducc.common.component.DuccLifecycle

Overrides:

start in class org.apache.uima.ducc.common.component.AbstractDuccComponent

Throws:

Exception

getEventDispatcherForRemoteProcess

public org.apache.uima.ducc.transport.dispatcher.DuccEventDispatcher getEventDispatcherForRemoteProcess()

duccLingExists
```
public boolean duccLingExists()
```

duccLingExists

public void duccLingExists(boolean duccLingExists)

runWithDuccLing
```
public boolean runWithDuccLing()
```

runWithDuccLing

public void runWithDuccLing(boolean runWithDuccLing)

getInventoryCopy

public HashMap<org.apache.uima.ducc.common.utils.id.DuccId,org.apache.uima.ducc.transport.event.common.IDuccProcess> getInventoryCopy()

Returns deep copy (by way of java serialization) of the Agents inventory.

Specified by:: getInventoryCopy in interface Agent

getInventoryRef

public HashMap<org.apache.uima.ducc.common.utils.id.DuccId,org.apache.uima.ducc.transport.event.common.IDuccProcess> getInventoryRef()

Returns shallow copy of the Agent's inventory

Specified by:: getInventoryRef in interface Agent

takeDownProcessWithNoJob
```
public void takeDownProcessWithNoJob(ProcessLifecycleController lifecycleController,
                            List<org.apache.uima.ducc.transport.event.common.IDuccJobDeployment> jobDeploymentList)
```
Stops any process that is in agent's inventory but not in provided job list sent by the PM.

Parameters:
lifecycleController - - instance implementing stopProcess() method
jobDeploymentList - - all DUCC jobs sent by PM

reconcileProcessStateAndTakeAction

public void reconcileProcessStateAndTakeAction(ProcessLifecycleController lifecycleController,
                                      org.apache.uima.ducc.transport.event.common.IDuccProcess process,
                                      org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine,
                                      org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info,
                                      org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment,
                                      org.apache.uima.ducc.common.utils.id.DuccId workDuccId)

Reconciles agent inventory with job processes sent by PM

Parameters:: lifecycleController - - instance implementing stopProcess and startProcess; process - - job process from a Job List; commandLine - - in case this process is not in agents inventory we need cmd line to start it; info - - DUCC common info including user log dir, user name, etc; workDuccId - - job id

doStartProcess

public void doStartProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
                  org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine,
                  org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info,
                  org.apache.uima.ducc.common.utils.id.DuccId workDuccId)

killProcessDueToLowSwapSpace
```
public void killProcessDueToLowSwapSpace(long minSwapThreshold)
```
Called when swap space on a node reached minimum as defined by ducc.node.min.swap.threshold in ducc.properties. The agent will find the biggest (in terms of memory) process in its inventory and stop it.

interruptThreadInWaitFor

public void interruptThreadInWaitFor(String pid)
                              throws Exception

Throws:: Exception

startProcess

public void startProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
                org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine,
                org.apache.uima.ducc.transport.event.common.IDuccStandardInfo info,
                org.apache.uima.ducc.common.utils.id.DuccId workDuccId,
                org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment)

Called when Agent receives request to start a process.

Specified by:: startProcess in interface ProcessLifecycleController
Parameters:: process - - IDuccProcess instance with identity (DuccId); commandLine - - fully defined command line that will be used to exec the process.

doStopProcess

public void doStopProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)

stopProcess
```
public void stopProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)
```
Called when Agent receives request to stop a process.

Specified by:

stopProcess in interface ProcessLifecycleController

Parameters:
process - - IDuccProcess instance with identity (DuccId)

purgeProcess

public void purgeProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process)
                  throws Exception

Remove given process from Agent's inventory

Parameters:: process - - process to purge from inventory
Throws:: Exception

updateProcessStatus
```
public void updateProcessStatus(org.apache.uima.ducc.transport.event.ProcessStateUpdateDuccEvent duccEvent)
                         throws Exception
```
Called when UIMA AS service wrapper sends an update when a process status changes.

Parameters:
duccEvent - - Ducc event object

Throws:

Exception

getIdentity

public org.apache.uima.ducc.common.NodeIdentity getIdentity()

Specified by:: getIdentity in interface Agent

onProcessExit
```
public void onProcessExit(org.apache.uima.ducc.transport.event.common.IDuccProcess process)
```
Called when a process exits.

Specified by:

onProcessExit in interface ProcessLifecycleObserver

onJPInitTimeout

public void onJPInitTimeout(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
                   long timeout)

Specified by:: onJPInitTimeout in interface ProcessLifecycleObserver

shutdown
```
public void shutdown(String reason)
```

lock

public static void lock()
                 throws Exception

Throws:: Exception

unlock

public static void unlock()
                   throws Exception

Throws:: Exception

isManagedProcess

public boolean isManagedProcess(Set<NodeUsersCollector.ProcessInfo> processList,
                       NodeUsersCollector.ProcessInfo cpi)

Specified by:: isManagedProcess in interface Agent

isRogueProcess

public boolean isRogueProcess(String uid,
                     Set<NodeUsersCollector.ProcessInfo> processList,
                     NodeUsersCollector.ProcessInfo cpi)
                       throws Exception

Specified by:: isRogueProcess in interface Agent
Throws:: Exception

stop
```
public void stop()
          throws Exception
```
Specified by:

stop in interface org.apache.uima.ducc.common.component.DuccLifecycle

Overrides:

stop in class org.apache.uima.ducc.common.component.AbstractDuccComponent

Throws:

Exception

getDeployedJPFuture

public Future<?> getDeployedJPFuture(org.apache.uima.ducc.common.utils.id.IDuccId duccId)

setReservations
```
public void setReservations(List<org.apache.uima.ducc.transport.event.common.DuccUserReservation> reserves)
                     throws Exception
```
Copies reservations sent by the PM. It copies reservations associated with this node.

Parameters:
reserves - - list of ALL reservations

Throws:

Exception

getUserReservations

public List<org.apache.uima.ducc.common.utils.id.DuccId> getUserReservations(String uid)

copyAllUserReservations

public void copyAllUserReservations(TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo> map)

Specified by:: copyAllUserReservations in interface Agent

userHasReservation

public boolean userHasReservation(String uid)
                           throws Exception

Throws:: Exception

deepCopy

public Object deepCopy(Object original)
                throws Exception

Throws:: Exception

getRogueProcessReaper
```
public RogueProcessReaper getRogueProcessReaper()
```
Specified by:

getRogueProcessReaper in interface Agent

main
```
public static void main(String[] args)
```
Called when an Agent receives self dispatched Ping message.

getLogger
```
public org.apache.uima.ducc.common.utils.DuccLogger getLogger()
```
Specified by:

getLogger in interface org.apache.uima.ducc.common.component.DuccComponent

handleAdminEvent
```
public void handleAdminEvent(org.apache.uima.ducc.common.admin.event.DuccAdminEvent event)
                      throws Exception
```
Specified by:

handleAdminEvent in interface org.apache.uima.ducc.common.component.DuccLifecycle

Overrides:

handleAdminEvent in class org.apache.uima.ducc.common.component.AbstractDuccComponent

Throws:

Exception

Class NodeAgent

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent

Field Summary

Fields inherited from interface org.apache.uima.ducc.agent.Agent

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent

Methods inherited from class java.lang.Object

Field Detail

logger

ProcessStateUpdatePort

SIGKILL

SIGTERM

logCounter

cgroupFailureReason

configurationFactory

useCgroups

cgroupsManager

node

excludeAPs

shareQuantum

virtualAgent

pageSizeFetched

pageSize

cpuClockRate

numProcessors

receivedDuccState

Constructor Detail

NodeAgent

NodeAgent

NodeAgent

Method Detail

getLastORSequence

getEventListener

setAgentEventListener

getNodeProcessors

getOSPageSize

getOSClockRate

setNodeInfo

getNodeInfo

getNodeTotalNumberOfShares

start

getEventDispatcherForRemoteProcess

duccLingExists

duccLingExists

runWithDuccLing

runWithDuccLing

getInventoryCopy

getInventoryRef

takeDownProcessWithNoJob

reconcileProcessStateAndTakeAction

doStartProcess

killProcessDueToLowSwapSpace

interruptThreadInWaitFor

startProcess

doStopProcess

stopProcess

purgeProcess

updateProcessStatus

getIdentity

onProcessExit

onJPInitTimeout

shutdown

lock

unlock

isManagedProcess

isRogueProcess

stop

getDeployedJPFuture

setReservations

getUserReservations

copyAllUserReservations

userHasReservation

deepCopy

getRogueProcessReaper

main

getLogger

handleAdminEvent