org.apache.paimon.benchmark.metric.cpu

Class ProcfsBasedProcessTree

java.lang.Object

org.apache.paimon.benchmark.metric.cpu.ProcfsBasedProcessTree

public class ProcfsBasedProcessTree
extends Object

A Proc file-system based ProcessTree. Works only on Linux. Based on ProcfsBasedProcessTree from YARN project.

Field Summary

Fields

Modifier and Type	Field and Description
static long	JIFFY_LENGTH_IN_MILLIS
static int	KB_TO_BYTES
static long	PAGE_SIZE
protected Map<String,org.apache.paimon.benchmark.metric.cpu.ProcfsBasedProcessTree.ProcessTreeSmapMemInfo>	processSMAPTree
protected Map<String,org.apache.paimon.benchmark.metric.cpu.ProcfsBasedProcessTree.ProcessInfo>	processTree
static String	PROCFS_CMDLINE_FILE
static String	PROCFS_STAT_FILE
static String	SMAPS
static int	UNAVAILABLE

Constructor Summary

Constructors

Constructor and Description
ProcfsBasedProcessTree()
ProcfsBasedProcessTree(boolean smapsEnabled)
ProcfsBasedProcessTree(String pid)
ProcfsBasedProcessTree(String pid, boolean smapsEnabled)
ProcfsBasedProcessTree(String pid, String procfsDir)
ProcfsBasedProcessTree(String pid, String procfsDir, Clock clock, boolean smapsEnabled) Build a new process tree rooted at the pid.

Method Summary

Modifier and Type	Method and Description
boolean	checkPidPgrpidForMatch() Verify that the given process id is same as its process group id.
static boolean	checkPidPgrpidForMatch(String _pid, String procfs)
boolean	contains(String pid) Returns boolean indicating whether pid is in process tree.
float	getCpuUsagePercent() Get the CPU usage by all the processes in the process-tree in Unix.
long	getCumulativeCpuTime()
List<String>	getCurrentProcessIDs()
String	getProcessTreeDump() Get a dump of the process-tree.
long	getRssMemorySize()
long	getRssMemorySize(int olderThanAge)
long	getVirtualMemorySize()
long	getVirtualMemorySize(int olderThanAge)
static void	main(String[] args) Test the ProcfsBasedProcessTree
void	setSmapsEnabled(boolean smapsEnabled)
String	toString() Returns a string printing PIDs of process present in the ProcfsBasedProcessTree.
void	updateProcessTree() Update process-tree with latest state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNAVAILABLE

public static final int UNAVAILABLE

See Also:

Constant Field Values

PROCFS_STAT_FILE

public static final String PROCFS_STAT_FILE

See Also:

Constant Field Values

PROCFS_CMDLINE_FILE

public static final String PROCFS_CMDLINE_FILE

See Also:

Constant Field Values

PAGE_SIZE

public static final long PAGE_SIZE

JIFFY_LENGTH_IN_MILLIS

public static final long JIFFY_LENGTH_IN_MILLIS

SMAPS

public static final String SMAPS

See Also:

Constant Field Values

KB_TO_BYTES

public static final int KB_TO_BYTES

See Also:

Constant Field Values

processSMAPTree

protected Map<String,org.apache.paimon.benchmark.metric.cpu.ProcfsBasedProcessTree.ProcessTreeSmapMemInfo> processSMAPTree

processTree

protected Map<String,org.apache.paimon.benchmark.metric.cpu.ProcfsBasedProcessTree.ProcessInfo> processTree

Constructor Detail

ProcfsBasedProcessTree

public ProcfsBasedProcessTree()
                       throws IOException

Throws:

IOException

ProcfsBasedProcessTree

public ProcfsBasedProcessTree(boolean smapsEnabled)
                       throws IOException

Throws:

IOException

ProcfsBasedProcessTree

public ProcfsBasedProcessTree(String pid)

ProcfsBasedProcessTree

public ProcfsBasedProcessTree(String pid,
                              boolean smapsEnabled)

ProcfsBasedProcessTree

public ProcfsBasedProcessTree(String pid,
                              String procfsDir)

ProcfsBasedProcessTree

public ProcfsBasedProcessTree(String pid,
                              String procfsDir,
                              Clock clock,
                              boolean smapsEnabled)

Build a new process tree rooted at the pid.

This method is provided mainly for testing purposes, where the root of the proc file system can be adjusted.

Parameters:

pid - root of the process tree

procfsDir - the root of a proc file system - only used for testing.

clock - clock for controlling time for testing

Method Detail

setSmapsEnabled

public void setSmapsEnabled(boolean smapsEnabled)

updateProcessTree

public void updateProcessTree()

Update process-tree with latest state. If the root-process is not alive, tree will be empty.

checkPidPgrpidForMatch

public boolean checkPidPgrpidForMatch()

Verify that the given process id is same as its process group id.

Returns:

true if the process id matches else return false.

checkPidPgrpidForMatch

public static boolean checkPidPgrpidForMatch(String _pid,
                                             String procfs)

getCurrentProcessIDs

public List<String> getCurrentProcessIDs()

getProcessTreeDump

public String getProcessTreeDump()

Get a dump of the process-tree.

Returns:

a string concatenating the dump of information of all the processes in the process-tree

getVirtualMemorySize

public long getVirtualMemorySize()

getVirtualMemorySize

public long getVirtualMemorySize(int olderThanAge)

getRssMemorySize

public long getRssMemorySize()

getRssMemorySize

public long getRssMemorySize(int olderThanAge)

getCumulativeCpuTime

public long getCumulativeCpuTime()

getCpuUsagePercent

public float getCpuUsagePercent()

Get the CPU usage by all the processes in the process-tree in Unix. Note: UNAVAILABLE will be returned in case when CPU usage is not available. It is NOT advised to return any other error code.

Returns:

percentage CPU usage since the process-tree was created, UNAVAILABLE if CPU usage cannot be calculated or not available.

toString

public String toString()

Returns a string printing PIDs of process present in the ProcfsBasedProcessTree. Output format : [pid pid ..]

Overrides:

toString in class Object

contains

public boolean contains(String pid)

Returns boolean indicating whether pid is in process tree.

main

public static void main(String[] args)

Test the ProcfsBasedProcessTree

Parameters:

args -