com.facebook.buck.util.perf

Class PerfStatsTracking.MemoryPerfStatsEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

com.facebook.buck.util.perf.PerfStatsTracking.PerfStatsEvent

com.facebook.buck.util.perf.PerfStatsTracking.MemoryPerfStatsEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface

Enclosing class:

PerfStatsTracking

public static class PerfStatsTracking.MemoryPerfStatsEvent
extends PerfStatsTracking.PerfStatsEvent

Performance event that tracks current memory usage of Buck

Field Summary

Fields inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

BUILD_FINISHED, BUILD_REPORT, BUILD_STARTED, BUILD_STATUS_EVENT, CACHE_RATE_STATS_UPDATE_EVENT, INDIVIDUAL_TEST_AWAITING_RESULTS, INSTALL_STARTED, PARSE_FINISHED, PARSE_STARTED, PROJECT_GENERATION_FINISHED, PROJECT_GENERATION_STARTED, TEST_RUN_STARTED

Constructor Summary

Constructors

Constructor and Description
MemoryPerfStatsEvent(long freeMemoryBytes, long totalMemoryBytes, long maxMemoryBytes, long timeSpentInGcMs, Map<String,Long> currentMemoryBytesUsageByPool) Construct a new memory performance tracking object

Method Summary

Modifier and Type	Method and Description
Map<String,Long>	getCurrentMemoryBytesUsageByPool()
long	getFreeMemoryBytes()
long	getMaxMemoryBytes()
long	getTimeSpentInGcMs()
long	getTotalMemoryBytes()

Methods inherited from class com.facebook.buck.util.perf.PerfStatsTracking.PerfStatsEvent

getEventName, getValueString

Methods inherited from class com.facebook.buck.event.AbstractBuckEvent

configure, equals, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, getTimestampMillis, hashCode, isConfigured, isRelatedTo, toLogMessage, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

storeLastInstanceAndReplayForNewClients

Constructor Detail

MemoryPerfStatsEvent

public MemoryPerfStatsEvent(long freeMemoryBytes,
                            long totalMemoryBytes,
                            long maxMemoryBytes,
                            long timeSpentInGcMs,
                            Map<String,Long> currentMemoryBytesUsageByPool)

Construct a new memory performance tracking object

Parameters:

freeMemoryBytes - Memory in bytes available for JVM to use for new allocations

totalMemoryBytes - Memory in bytes that JVM allocated at the moment, both used and unused

maxMemoryBytes - Maximum amount of memory in bytes that JVM can allocate (-Xmx parameter)

timeSpentInGcMs - Total amount of milliseconds spent doing garbage collection till now

currentMemoryBytesUsageByPool - A map of JVM memory pool name to the amount of memory used by that pool

Method Detail

getFreeMemoryBytes

public long getFreeMemoryBytes()

Returns:

Memory in bytes available for JVM to use for new allocations

getTotalMemoryBytes

public long getTotalMemoryBytes()

Returns:

Memory in bytes that JVM allocated at the moment, both used and unused

getMaxMemoryBytes

public long getMaxMemoryBytes()

Returns:

Maximum amount of memory in bytes that JVM can allocate (-Xmx parameter)

getTimeSpentInGcMs

public long getTimeSpentInGcMs()

Returns:

Total amount of milliseconds spent doing garbage collection till now

getCurrentMemoryBytesUsageByPool

public Map<String,Long> getCurrentMemoryBytesUsageByPool()

Returns:

A map of JVM memory pool name to the amount of memory used by that pool