com.facebook.buck.event.listener

Class AbstractConsoleEventBusListener

java.lang.Object

com.facebook.buck.event.listener.AbstractConsoleEventBusListener

All Implemented Interfaces:

BuckEventListener, Closeable, AutoCloseable

Direct Known Subclasses:

SilentConsoleEventBusListener, SimpleConsoleEventBusListener, SuperConsoleEventBusListener

public abstract class AbstractConsoleEventBusListener
extends Object
implements BuckEventListener

Base class for BuckEventListeners responsible for outputting information about the running build to stderr.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<EventKey,EventInterval>	actionGraphEvents
protected ConcurrentLinkedDeque<ActionGraphEvent.Finished>	actionGraphFinished
protected ConcurrentLinkedDeque<ActionGraphEvent.Started>	actionGraphStarted
protected Ansi	ansi
protected com.google.common.collect.ImmutableSet<String>	buildDetailsCommands Commands that should print out the build details, if provided
protected BuildEvent.Finished	buildFinished
protected BuildRuleThreadTracker	buildRuleThreadTracker
protected BuildEvent.Started	buildStarted
protected Clock	clock
protected CommandEvent.Finished	commandFinished
protected RenderingConsole	console
protected InstallEvent.Finished	installFinished
protected InstallEvent.Started	installStarted
protected NetworkStatsTracker	networkStatsTracker
protected AtomicInteger	numRulesCompleted
protected ParseStatsTracker	parseStats
protected Optional<ProgressEstimator>	progressEstimator
protected ProjectGenerationEvent.Finished	projectGenerationFinished
protected ProjectGenerationEvent.Started	projectGenerationStarted
protected Optional<String>	publicAnnouncements
protected OptionalInt	ruleCount
protected static long	UNFINISHED_EVENT_PAIR
protected Verbosity	verbosity
protected WatchmanStatusEvent.Finished	watchmanFinished
protected WatchmanStatusEvent.Started	watchmanStarted

Constructor Summary

Constructors

Constructor and Description
AbstractConsoleEventBusListener(RenderingConsole console, Clock clock, Locale locale, ExecutionEnvironment executionEnvironment, boolean showTextInAllCaps, int numberOfSlowRulesToShow, boolean showSlowRulesInConsole, com.google.common.collect.ImmutableSet<String> buildDetailsCommands)

Method Summary

Modifier and Type	Method and Description
void	actionGraphFinished(ActionGraphEvent.Finished finished)
void	actionGraphStarted(ActionGraphEvent.Started started)
protected boolean	addLineFromEventInterval(String prefix, Optional<String> suffix, long currentMillis, EventInterval startAndFinish, ProgressEstimation progress, Optional<Long> minimum, com.google.common.collect.ImmutableList.Builder<String> lines) Adds a line about an EventInterval to lines.
protected boolean	addLineFromEvents(String prefix, Optional<String> suffix, long currentMillis, Collection<EventInterval> eventIntervals, ProgressEstimation progress, Optional<Long> minimum, com.google.common.collect.ImmutableList.Builder<String> lines) Adds a line about a set of start and finished events to lines.
static void	aggregateFinishedEvent(ConcurrentHashMap<EventKey,EventInterval> map, BuckEvent finished)
static void	aggregateStartedEvent(ConcurrentHashMap<EventKey,EventInterval> map, BuckEvent started)
void	buildFinished(BuildEvent.Finished finished)
void	buildRuleFinished(BuildRuleEvent.Finished finished)
void	buildRuleResumed(BuildRuleEvent.Resumed resumed)
void	buildRuleStarted(BuildRuleEvent.Started started)
void	buildRuleSuspended(BuildRuleEvent.Suspended suspended)
void	buildStarted(BuildEvent.Started started)
void	close() Cleanup, output any trace data collected to the backing store.
void	commandFinished(CommandEvent.Finished event)
void	commandStartedEvent(CommandEvent.Started startedEvent)
protected String	convertToAllCapsIfNeeded(String str)
boolean	displaysEstimatedProgress()
protected com.google.common.collect.ImmutableList<String>	formatConsoleEvent(ConsoleEvent logEvent) Formats a ConsoleEvent and adds it to lines.
protected String	formatElapsedTime(long elapsedTimeMs)
protected Optional<Double>	getApproximateBuildProgress()
static String	getBuildDetailsLine(BuildId buildId, String buildDetailsTemplate)
static String	getBuildLogLine(BuildId buildId)
protected ProgressEstimation	getEstimatedProgressOfCreatingActionGraph()
protected Optional<Double>	getEstimatedProgressOfGeneratingProjectFiles()
protected ProgressEstimation	getEstimatedProgressOfParsingBuckFiles()
protected static Collection<EventInterval>	getEventsBetween(long start, long end, Iterable<EventInterval> eventIntervals) Filter a list of events and return the subset that fall between the given start and end timestamps.
protected String	getNetworkStatsLine(BuildEvent.Finished finishedEvent)
protected Optional<String>	getOptionalBuildLineSuffix()
protected static long	getTotalCompletedTimeFromEventIntervals(Collection<EventInterval> eventIntervals) Get the summed elapsed time from all matched event pairs.
protected static long	getWorkingTimeFromLastStartUntilNow(Collection<EventInterval> eventIntervals, long currentMillis) Deprecated.
void	installFinished(InstallEvent.Finished finished)
void	installStarted(InstallEvent.Started started)
protected long	logEventInterval(String prefix, Optional<String> suffix, long currentMillis, long offsetMs, BuckEvent startEvent, BuckEvent finishedEvent, Optional<Double> progress, Optional<Long> minimum, com.google.common.collect.ImmutableList.Builder<String> lines) Adds a line about a pair of start and finished events to lines.
protected long	logEventInterval(String prefix, Optional<String> suffix, long currentMillis, long offsetMs, Collection<EventInterval> eventIntervals, Optional<Double> progress, Optional<Long> minimum, com.google.common.collect.ImmutableList.Builder<String> lines) Deprecated.
protected void	logHttpCacheUploads(com.google.common.collect.ImmutableList.Builder<String> lines) Adds a line about a the state of cache uploads to lines.
abstract void	printSevereWarningDirectly(String line)
void	projectGenerationFinished(ProjectGenerationEvent.Finished finished)
void	projectGenerationProcessedTarget(ProjectGenerationEvent.Processed processed)
void	projectGenerationStarted(ProjectGenerationEvent.Started started)
void	register(BuckEventBus buildEventBus)
protected String	renderRemoteUploads() A method to print the line responsible to show how our remote cache upload goes.
void	ruleCountCalculated(BuildEvent.RuleCountCalculated calculated)
void	ruleCountUpdated(BuildEvent.UnskippedRuleCountUpdated updated)
void	setProgressEstimator(ProgressEstimator estimator)
void	setPublicAnnouncements(BuckEventBus eventBus, Optional<String> announcements)
void	testRuleFinished(TestRuleEvent.Finished finished)
void	testRuleStarted(TestRuleEvent.Started started)
void	watchmanFinished(WatchmanStatusEvent.Finished finished)
void	watchmanStarted(WatchmanStatusEvent.Started started)

Methods inherited from class java.lang.Object

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

Field Detail

UNFINISHED_EVENT_PAIR

protected static final long UNFINISHED_EVENT_PAIR

See Also:

Constant Field Values

console

protected final RenderingConsole console

clock

protected final Clock clock

verbosity

protected final Verbosity verbosity

ansi

protected final Ansi ansi

projectGenerationStarted

@Nullable
protected volatile ProjectGenerationEvent.Started projectGenerationStarted

projectGenerationFinished

@Nullable
protected volatile ProjectGenerationEvent.Finished projectGenerationFinished

watchmanStarted

@Nullable
protected volatile WatchmanStatusEvent.Started watchmanStarted

watchmanFinished

@Nullable
protected volatile WatchmanStatusEvent.Finished watchmanFinished

actionGraphStarted

protected ConcurrentLinkedDeque<ActionGraphEvent.Started> actionGraphStarted

actionGraphFinished

protected ConcurrentLinkedDeque<ActionGraphEvent.Finished> actionGraphFinished

actionGraphEvents

protected ConcurrentHashMap<EventKey,EventInterval> actionGraphEvents

buildStarted

@Nullable
protected volatile BuildEvent.Started buildStarted

buildFinished

@Nullable
protected volatile BuildEvent.Finished buildFinished

installStarted

@Nullable
protected volatile InstallEvent.Started installStarted

installFinished

@Nullable
protected volatile InstallEvent.Finished installFinished

commandFinished

@Nullable
protected volatile CommandEvent.Finished commandFinished

ruleCount

protected volatile OptionalInt ruleCount

publicAnnouncements

protected Optional<String> publicAnnouncements

numRulesCompleted

protected final AtomicInteger numRulesCompleted

progressEstimator

protected Optional<ProgressEstimator> progressEstimator

networkStatsTracker

protected final NetworkStatsTracker networkStatsTracker

parseStats

protected final ParseStatsTracker parseStats

buildRuleThreadTracker

protected BuildRuleThreadTracker buildRuleThreadTracker

buildDetailsCommands

protected final com.google.common.collect.ImmutableSet<String> buildDetailsCommands

Commands that should print out the build details, if provided

Constructor Detail

AbstractConsoleEventBusListener

public AbstractConsoleEventBusListener(RenderingConsole console,
                                       Clock clock,
                                       Locale locale,
                                       ExecutionEnvironment executionEnvironment,
                                       boolean showTextInAllCaps,
                                       int numberOfSlowRulesToShow,
                                       boolean showSlowRulesInConsole,
                                       com.google.common.collect.ImmutableSet<String> buildDetailsCommands)

Method Detail

register

public void register(BuckEventBus buildEventBus)

getBuildDetailsLine

public static String getBuildDetailsLine(BuildId buildId,
                                         String buildDetailsTemplate)

getBuildLogLine

public static String getBuildLogLine(BuildId buildId)

displaysEstimatedProgress

public boolean displaysEstimatedProgress()

setProgressEstimator

public void setProgressEstimator(ProgressEstimator estimator)

formatElapsedTime

protected String formatElapsedTime(long elapsedTimeMs)

getApproximateBuildProgress

protected Optional<Double> getApproximateBuildProgress()

getEstimatedProgressOfGeneratingProjectFiles

protected Optional<Double> getEstimatedProgressOfGeneratingProjectFiles()

getEstimatedProgressOfParsingBuckFiles

protected ProgressEstimation getEstimatedProgressOfParsingBuckFiles()

Returns:

Estimated progress of parsing files stage.

getEstimatedProgressOfCreatingActionGraph

protected ProgressEstimation getEstimatedProgressOfCreatingActionGraph()

Returns:

Estimated progress of parsing files stage.

setPublicAnnouncements

public void setPublicAnnouncements(BuckEventBus eventBus,
                                   Optional<String> announcements)

printSevereWarningDirectly

public abstract void printSevereWarningDirectly(String line)

getEventsBetween

protected static Collection<EventInterval> getEventsBetween(long start,
                                                            long end,
                                                            Iterable<EventInterval> eventIntervals)

Filter a list of events and return the subset that fall between the given start and end timestamps. Preserves ordering if the given iterable was ordered. Will replace event pairs that straddle the boundary with com.facebook.buck.event.listener.ProxyBuckEvent instances, so that the resulting collection is strictly contained within the boundaries.

Parameters:

start - the start timestamp (inclusive)

end - the end timestamp (also inclusive)

eventIntervals - the events to filter.

Returns:

a list of all events from the given iterable that fall between the given start and end times. If an event straddles the given start or end, it will be replaced with a proxy event pair that cuts off at exactly the start or end.

convertToAllCapsIfNeeded

protected String convertToAllCapsIfNeeded(String str)

logEventInterval

protected long logEventInterval(String prefix,
                                Optional<String> suffix,
                                long currentMillis,
                                long offsetMs,
                                @Nullable
                                BuckEvent startEvent,
                                @Nullable
                                BuckEvent finishedEvent,
                                Optional<Double> progress,
                                Optional<Long> minimum,
                                com.google.common.collect.ImmutableList.Builder<String> lines)

Adds a line about a pair of start and finished events to lines.

Parameters:

prefix - Prefix to print for this event pair.

suffix - Suffix to print for this event pair.

currentMillis - The current time in milliseconds.

offsetMs - Offset to remove from calculated time. Set this to a non-zero value if the event pair would contain another event. For example, build time includes parse time, but to make the events easier to reason about it makes sense to pull parse time out of build time.

startEvent - The started event.

finishedEvent - The finished event.

lines - The builder to append lines to.

Returns:

The amount of time between start and finished if finished is present, otherwise UNFINISHED_EVENT_PAIR.

logHttpCacheUploads

protected void logHttpCacheUploads(com.google.common.collect.ImmutableList.Builder<String> lines)

Adds a line about a the state of cache uploads to lines.

Parameters:

lines - The builder to append lines to.

addLineFromEvents

protected boolean addLineFromEvents(String prefix,
                                    Optional<String> suffix,
                                    long currentMillis,
                                    Collection<EventInterval> eventIntervals,
                                    ProgressEstimation progress,
                                    Optional<Long> minimum,
                                    com.google.common.collect.ImmutableList.Builder<String> lines)

Adds a line about a set of start and finished events to lines.

Parameters:

prefix - Prefix to print for this event pair.

suffix - Suffix to print for this event pair.

currentMillis - The current time in milliseconds.

eventIntervals - the collection of start/end events to measure elapsed time.

lines - The builder to append lines to.

Returns:

True if all events are finished, false otherwise

addLineFromEventInterval

protected boolean addLineFromEventInterval(String prefix,
                                           Optional<String> suffix,
                                           long currentMillis,
                                           EventInterval startAndFinish,
                                           ProgressEstimation progress,
                                           Optional<Long> minimum,
                                           com.google.common.collect.ImmutableList.Builder<String> lines)

Adds a line about an EventInterval to lines.

Parameters:

prefix - Prefix to print for this event pair.

suffix - Suffix to print for this event pair.

currentMillis - The current time in milliseconds.

startAndFinish - the event interval to measure elapsed time.

lines - The builder to append lines to.

Returns:

True if all events are finished, false otherwise

logEventInterval

@Deprecated
protected long logEventInterval(String prefix,
                                            Optional<String> suffix,
                                            long currentMillis,
                                            long offsetMs,
                                            Collection<EventInterval> eventIntervals,
                                            Optional<Double> progress,
                                            Optional<Long> minimum,
                                            com.google.common.collect.ImmutableList.Builder<String> lines)

Deprecated.

Adds a line about a set of start and finished events to lines.

Parameters:

prefix - Prefix to print for this event pair.

suffix - Suffix to print for this event pair.

currentMillis - The current time in milliseconds.

offsetMs - Offset to remove from calculated time. Set this to a non-zero value if the event pair would contain another event. For example, build time includes parse time, but to make the events easier to reason about it makes sense to pull parse time out of build time.

eventIntervals - the collection of start/end events to sum up when calculating elapsed time.

lines - The builder to append lines to.

Returns:

The summed time between start and finished events if each start event has a matching finished event, otherwise UNFINISHED_EVENT_PAIR.

getWorkingTimeFromLastStartUntilNow

@Deprecated
protected static long getWorkingTimeFromLastStartUntilNow(Collection<EventInterval> eventIntervals,
                                                                      long currentMillis)

Deprecated.

Takes a collection of start and finished events. If there are any events that have a start, but no finished time, the collection is considered ongoing.

Parameters:

eventIntervals - the collection of event starts/stops.

currentMillis - the current time.

Returns:

-1 if all events are completed, otherwise the time elapsed between the latest event and currentMillis.

getTotalCompletedTimeFromEventIntervals

protected static long getTotalCompletedTimeFromEventIntervals(Collection<EventInterval> eventIntervals)

Get the summed elapsed time from all matched event pairs. Does not consider unmatched event pairs. Pairs are determined by their EventKey.

Parameters:

eventIntervals - a set of paired events (incomplete events are okay).

Returns:

the sum of all times between matched event pairs.

formatConsoleEvent

protected com.google.common.collect.ImmutableList<String> formatConsoleEvent(ConsoleEvent logEvent)

Formats a ConsoleEvent and adds it to lines.

commandStartedEvent

public void commandStartedEvent(CommandEvent.Started startedEvent)

aggregateStartedEvent

public static void aggregateStartedEvent(ConcurrentHashMap<EventKey,EventInterval> map,
                                         BuckEvent started)

aggregateFinishedEvent

public static void aggregateFinishedEvent(ConcurrentHashMap<EventKey,EventInterval> map,
                                          BuckEvent finished)

projectGenerationStarted

public void projectGenerationStarted(ProjectGenerationEvent.Started started)

projectGenerationProcessedTarget

public void projectGenerationProcessedTarget(ProjectGenerationEvent.Processed processed)

projectGenerationFinished

public void projectGenerationFinished(ProjectGenerationEvent.Finished finished)

watchmanStarted

public void watchmanStarted(WatchmanStatusEvent.Started started)

watchmanFinished

public void watchmanFinished(WatchmanStatusEvent.Finished finished)

actionGraphStarted

public void actionGraphStarted(ActionGraphEvent.Started started)

actionGraphFinished

public void actionGraphFinished(ActionGraphEvent.Finished finished)

buildStarted

public void buildStarted(BuildEvent.Started started)

ruleCountCalculated

public void ruleCountCalculated(BuildEvent.RuleCountCalculated calculated)

ruleCountUpdated

public void ruleCountUpdated(BuildEvent.UnskippedRuleCountUpdated updated)

getOptionalBuildLineSuffix

protected Optional<String> getOptionalBuildLineSuffix()

getNetworkStatsLine

protected String getNetworkStatsLine(@Nullable
                                     BuildEvent.Finished finishedEvent)

buildRuleStarted

public void buildRuleStarted(BuildRuleEvent.Started started)

buildRuleResumed

public void buildRuleResumed(BuildRuleEvent.Resumed resumed)

buildRuleSuspended

public void buildRuleSuspended(BuildRuleEvent.Suspended suspended)

buildRuleFinished

public void buildRuleFinished(BuildRuleEvent.Finished finished)

buildFinished

public void buildFinished(BuildEvent.Finished finished)

testRuleStarted

public void testRuleStarted(TestRuleEvent.Started started)

testRuleFinished

public void testRuleFinished(TestRuleEvent.Finished finished)

installStarted

public void installStarted(InstallEvent.Started started)

installFinished

public void installFinished(InstallEvent.Finished finished)

commandFinished

public void commandFinished(CommandEvent.Finished event)

renderRemoteUploads

protected String renderRemoteUploads()

A method to print the line responsible to show how our remote cache upload goes.

Returns:

the line

close

public void close()
           throws IOException

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

Throws:

IOException