com.facebook.buck.event.listener

Class ChromeTraceBuildListener

java.lang.Object

com.facebook.buck.event.listener.ChromeTraceBuildListener

All Implemented Interfaces:

BuckEventListener, Closeable, AutoCloseable

public class ChromeTraceBuildListener
extends Object
implements BuckEventListener

Logs events to a json file formatted to be viewed in Chrome Trace View (chrome://tracing).

Constructor Summary

Constructors

Constructor and Description
ChromeTraceBuildListener(ProjectFilesystem projectFilesystem, InvocationInfo invocationInfo, Clock clock, ChromeTraceBuckConfig config, TaskManagerCommandScope managerScope, Optional<RemoteExecutionStatsProvider> reStatsProvider, CriticalPathEventListener criticalPathEventListener)

Method Summary

Modifier and Type	Method and Description
void	actionGraphCacheHit(ActionGraphEvent.Cache.Hit hit)
void	actionGraphCacheMiss(ActionGraphEvent.Cache.Miss miss)
void	actionGraphFinished(ActionGraphEvent.Finished finished)
void	actionGraphStarted(ActionGraphEvent.Started started)
void	annotationProcessingFinished(AnnotationProcessingEvent.Finished finished)
void	annotationProcessingStarted(AnnotationProcessingEvent.Started started)
void	artifactCacheEventFinished(ArtifactCacheEvent.Finished finished)
void	artifactCacheEventStarted(ArtifactCacheEvent.Started started)
void	artifactCompressionFinished(ArtifactCompressionEvent.Finished finished)
void	artifactCompressionStarted(ArtifactCompressionEvent.Started started)
void	artifactConnectFinished(ArtifactCacheConnectEvent.Finished finished)
void	artifactConnectStarted(ArtifactCacheConnectEvent.Started started)
void	buildFinished(BuildEvent.Finished finished)
void	buildStarted(BuildEvent.Started started)
void	close() Cleanup, output any trace data collected to the backing store.
void	commandFinished(CommandEvent.Finished finished)
void	commandStarted(CommandEvent.Started started)
void	compilerPluginDurationEventFinished(CompilerPluginDurationEvent.Finished finished)
void	compilerPluginDurationEventStarted(CompilerPluginDurationEvent.Started started)
void	externalTestRunFinished(ExternalTestRunEvent.Finished finished)
void	externalTestRunStarted(ExternalTestRunEvent.Started started)
void	externalTestSpecCalculationFinished(ExternalTestSpecCalculationEvent.Finished finished)
void	externalTestSpecCalculationStarted(ExternalTestSpecCalculationEvent.Started started)
void	installFinished(InstallEvent.Finished finished)
void	installStarted(InstallEvent.Started started)
void	javacPhaseFinished(JavacPhaseEvent.Finished finished)
void	javacPhaseStarted(JavacPhaseEvent.Started started)
void	memoryPerfStats(PerfStatsTracking.MemoryPerfStatsEvent memory)
void	onActionEventFinished(RemoteExecutionActionEvent.Finished event) Add metadata for actions in each Remote Execution state
void	onActionEventStarted(RemoteExecutionActionEvent.Started event) Add metadata for actions in each Remote Execution state
void	onRemoteExecutionSessionFinished(RemoteExecutionSessionEvent.Finished event) Mark the end of a Remote Execution session and write down the related telemetry.
void	onRemoteExecutionSessionStarted(RemoteExecutionSessionEvent.Started event) Mark the start of a Remote Execution session
void	onWatchmanOverflow(WatchmanStatusEvent.Overflow event)
void	parseBuckFileFinished(ParseBuckFileEvent.Finished finished)
void	parseBuckFileStarted(ParseBuckFileEvent.Started started)
void	parseFinished(ParseEvent.Finished finished)
void	parseStarted(ParseEvent.Started started)
void	processResourceConsumption(ProcessTracker.ProcessResourceConsumptionEvent event)
void	ruleFinished(BuildRuleEvent.Finished finished)
void	ruleKeyCalculationFinished(RuleKeyCalculationEvent.Finished finished)
void	ruleKeyCalculationStarted(RuleKeyCalculationEvent.Started started)
void	ruleResumed(BuildRuleEvent.Resumed resumed)
void	ruleStarted(BuildRuleEvent.Started started)
void	ruleSuspended(BuildRuleEvent.Suspended suspended)
void	simpleLeafEventFinished(LeafEvents.SimpleLeafEvent.Finished finished)
void	simpleLeafEventStarted(LeafEvents.SimpleLeafEvent.Started started)
void	simplePerfEvent(SimplePerfEvent perfEvent)
void	startActivityFinished(StartActivityEvent.Finished finished)
void	startActivityStarted(StartActivityEvent.Started started)
void	stepFinished(StepEvent.Finished finished)
void	stepStarted(StepEvent.Started started)
void	testFinishedEvent(TestSummaryEvent.Finished finished)
void	testStartedEvent(TestSummaryEvent.Started started)
void	uninstallFinished(UninstallEvent.Finished finished)
void	uninstallStarted(UninstallEvent.Started started)
void	writeArtifactCompressionEvent(ArtifactCompressionEvent event, ChromeTraceEvent.Phase phase, com.google.common.collect.ImmutableMap.Builder<String,String> builder)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChromeTraceBuildListener

public ChromeTraceBuildListener(ProjectFilesystem projectFilesystem,
                                InvocationInfo invocationInfo,
                                Clock clock,
                                ChromeTraceBuckConfig config,
                                TaskManagerCommandScope managerScope,
                                Optional<RemoteExecutionStatsProvider> reStatsProvider,
                                CriticalPathEventListener criticalPathEventListener)
                         throws IOException

Throws:

IOException

Method Detail

close

public void close()

Description copied from interface: BuckEventListener

Cleanup, output any trace data collected to the backing store.

Specified by:

close in interface BuckEventListener

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

commandStarted

public void commandStarted(CommandEvent.Started started)

commandFinished

public void commandFinished(CommandEvent.Finished finished)

buildStarted

public void buildStarted(BuildEvent.Started started)

buildFinished

public void buildFinished(BuildEvent.Finished finished)

ruleStarted

public void ruleStarted(BuildRuleEvent.Started started)

ruleFinished

public void ruleFinished(BuildRuleEvent.Finished finished)

ruleResumed

public void ruleResumed(BuildRuleEvent.Resumed resumed)

ruleSuspended

public void ruleSuspended(BuildRuleEvent.Suspended suspended)

stepStarted

public void stepStarted(StepEvent.Started started)

stepFinished

public void stepFinished(StepEvent.Finished finished)

simpleLeafEventStarted

public void simpleLeafEventStarted(LeafEvents.SimpleLeafEvent.Started started)

simpleLeafEventFinished

public void simpleLeafEventFinished(LeafEvents.SimpleLeafEvent.Finished finished)

parseStarted

public void parseStarted(ParseEvent.Started started)

parseFinished

public void parseFinished(ParseEvent.Finished finished)

simplePerfEvent

public void simplePerfEvent(SimplePerfEvent perfEvent)

parseBuckFileStarted

public void parseBuckFileStarted(ParseBuckFileEvent.Started started)

parseBuckFileFinished

public void parseBuckFileFinished(ParseBuckFileEvent.Finished finished)

actionGraphStarted

public void actionGraphStarted(ActionGraphEvent.Started started)

actionGraphFinished

public void actionGraphFinished(ActionGraphEvent.Finished finished)

actionGraphCacheHit

public void actionGraphCacheHit(ActionGraphEvent.Cache.Hit hit)

actionGraphCacheMiss

public void actionGraphCacheMiss(ActionGraphEvent.Cache.Miss miss)

installStarted

public void installStarted(InstallEvent.Started started)

installFinished

public void installFinished(InstallEvent.Finished finished)

startActivityStarted

public void startActivityStarted(StartActivityEvent.Started started)

startActivityFinished

public void startActivityFinished(StartActivityEvent.Finished finished)

uninstallStarted

public void uninstallStarted(UninstallEvent.Started started)

uninstallFinished

public void uninstallFinished(UninstallEvent.Finished finished)

artifactCacheEventStarted

public void artifactCacheEventStarted(ArtifactCacheEvent.Started started)

artifactCacheEventFinished

public void artifactCacheEventFinished(ArtifactCacheEvent.Finished finished)

artifactCompressionStarted

public void artifactCompressionStarted(ArtifactCompressionEvent.Started started)

artifactCompressionFinished

public void artifactCompressionFinished(ArtifactCompressionEvent.Finished finished)

writeArtifactCompressionEvent

public void writeArtifactCompressionEvent(ArtifactCompressionEvent event,
                                          ChromeTraceEvent.Phase phase,
                                          com.google.common.collect.ImmutableMap.Builder<String,String> builder)

artifactConnectStarted

public void artifactConnectStarted(ArtifactCacheConnectEvent.Started started)

artifactConnectFinished

public void artifactConnectFinished(ArtifactCacheConnectEvent.Finished finished)

javacPhaseStarted

public void javacPhaseStarted(JavacPhaseEvent.Started started)

javacPhaseFinished

public void javacPhaseFinished(JavacPhaseEvent.Finished finished)

annotationProcessingStarted

public void annotationProcessingStarted(AnnotationProcessingEvent.Started started)

annotationProcessingFinished

public void annotationProcessingFinished(AnnotationProcessingEvent.Finished finished)

compilerPluginDurationEventStarted

public void compilerPluginDurationEventStarted(CompilerPluginDurationEvent.Started started)

compilerPluginDurationEventFinished

public void compilerPluginDurationEventFinished(CompilerPluginDurationEvent.Finished finished)

memoryPerfStats

public void memoryPerfStats(PerfStatsTracking.MemoryPerfStatsEvent memory)

processResourceConsumption

public void processResourceConsumption(ProcessTracker.ProcessResourceConsumptionEvent event)

testStartedEvent

public void testStartedEvent(TestSummaryEvent.Started started)

testFinishedEvent

public void testFinishedEvent(TestSummaryEvent.Finished finished)

ruleKeyCalculationStarted

public void ruleKeyCalculationStarted(RuleKeyCalculationEvent.Started started)

ruleKeyCalculationFinished

public void ruleKeyCalculationFinished(RuleKeyCalculationEvent.Finished finished)

externalTestSpecCalculationStarted

public void externalTestSpecCalculationStarted(ExternalTestSpecCalculationEvent.Started started)

externalTestSpecCalculationFinished

public void externalTestSpecCalculationFinished(ExternalTestSpecCalculationEvent.Finished finished)

externalTestRunStarted

public void externalTestRunStarted(ExternalTestRunEvent.Started started)

externalTestRunFinished

public void externalTestRunFinished(ExternalTestRunEvent.Finished finished)

onWatchmanOverflow

public void onWatchmanOverflow(WatchmanStatusEvent.Overflow event)

onActionEventStarted

public void onActionEventStarted(RemoteExecutionActionEvent.Started event)

Add metadata for actions in each Remote Execution state

onActionEventFinished

public void onActionEventFinished(RemoteExecutionActionEvent.Finished event)

Add metadata for actions in each Remote Execution state

onRemoteExecutionSessionStarted

public void onRemoteExecutionSessionStarted(RemoteExecutionSessionEvent.Started event)

Mark the start of a Remote Execution session

onRemoteExecutionSessionFinished

public void onRemoteExecutionSessionFinished(RemoteExecutionSessionEvent.Finished event)

Mark the end of a Remote Execution session and write down the related telemetry.