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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.uima.ducc.agent.metrics.collectors.NodeUsersCollector

All Implemented Interfaces:

Callable<TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo>>, CallableNodeUsersCollector
```
public class NodeUsersCollector
extends Object
implements CallableNodeUsersCollector
```
Spawns "ps -ef --no-heading" cmd and scrapes the output to collect user processes. Detects and filters out Ducc daemon processes and AMQ broker. Detects rogue processes which are processes that are not associated with any job and not belonging to a user node reservation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class NodeUsersCollector.ProcessInfo

class NodeUsersCollector.RunningProcess

Constructor Summary

Constructors
Constructor and Description

NodeUsersCollector(Agent agent, org.apache.uima.ducc.common.utils.DuccLogger logger)

Method Summary

Methods
Modifier and Type	Method and Description
`TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo>`	`call()`
`boolean`	`excludeProcess(String process)` Returns true if a given process belongs to an exclusion list defined in ducc.properties.
`boolean`	`excludeUser(String userId)` Returns true if a given userId belongs to an exclusion list defined in ducc.properties.
`static void`	`main(String[] args)`

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

- Constructor Detail
  - NodeUsersCollector
```
public NodeUsersCollector(Agent agent,
                  org.apache.uima.ducc.common.utils.DuccLogger logger)
```
- Method Detail
  - excludeUser
```
public boolean excludeUser(String userId)
```
    Returns true if a given userId belongs to an exclusion list defined in ducc.properties. This list contains user IDs the Agent should exclude while determining rogue processes. System owned (root, nfs, etc) processes should not be reported as rogue.
    
    Parameters:
    userId -
    
    Returns:
    boolean - true if a given user should be excluded. False otherwise
  - excludeProcess
```
public boolean excludeProcess(String process)
```
    Returns true if a given process belongs to an exclusion list defined in ducc.properties. This list contains process names the Agent should exclude while determining rogue processes.
    
    Parameters:
    process -
    
    Returns:
    boolean - true if a given process should be excluded. False otherwise
  - call
```
public TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo> call()
                                                                            throws Exception
```
    Specified by:
    
    call in interface Callable<TreeMap<String,org.apache.uima.ducc.common.node.metrics.NodeUsersInfo>>
    
    Throws:
    
    Exception
  - main
```
public static void main(String[] args)
```

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012–2017 The Apache Software Foundation. All rights reserved.