com.facebook.buck.util.perf

Class ProcessTracker

java.lang.Object

com.google.common.util.concurrent.AbstractScheduledService

com.facebook.buck.util.perf.ProcessTracker

All Implemented Interfaces:

com.google.common.util.concurrent.Service, AutoCloseable

public class ProcessTracker
extends com.google.common.util.concurrent.AbstractScheduledService
implements AutoCloseable

A tracker that periodically probes for external processes resource consumption.

Resource consumption has to be gathered periodically because it can only be retrieved while the process is still alive and we have no way of knowing or even controlling when the process is going to finish (assuming it finishes execution on its own). Furthermore, for some metrics (such as memory usage) only the current values get reported and we need to keep track of peak usage manually. Gathering only the current values just before the process finishes (assuming this was possible) would likely be highly inaccurate anyways as the process probably released most of its resources by that time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessTracker.ProcessResourceConsumptionEvent

Nested classes/interfaces inherited from class com.google.common.util.concurrent.AbstractScheduledService

com.google.common.util.concurrent.AbstractScheduledService.CustomScheduler, com.google.common.util.concurrent.AbstractScheduledService.Scheduler

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Constructor and Description
ProcessTracker(BuckEventBus buckEventBus, InvocationInfo invocationInfo, boolean isDaemon, boolean deepEnabled)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	runOneIteration()
protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler	scheduler()
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractScheduledService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessTracker

public ProcessTracker(BuckEventBus buckEventBus,
                      InvocationInfo invocationInfo,
                      boolean isDaemon,
                      boolean deepEnabled)

Method Detail

startUp

protected void startUp()

Overrides:

startUp in class com.google.common.util.concurrent.AbstractScheduledService

runOneIteration

protected void runOneIteration()

Specified by:

runOneIteration in class com.google.common.util.concurrent.AbstractScheduledService

shutDown

protected void shutDown()

Overrides:

shutDown in class com.google.common.util.concurrent.AbstractScheduledService

scheduler

protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler scheduler()

Specified by:

scheduler in class com.google.common.util.concurrent.AbstractScheduledService

close

public void close()

Specified by:

close in interface AutoCloseable