com.facebook.buck.event

Interface LeafEvent

All Superinterfaces:

BuckEvent, BuckEventExternalInterface

All Known Subinterfaces:

RuleKeyCalculationEvent, RuleKeyCalculationEvent.Finished, RuleKeyCalculationEvent.Started

All Known Implementing Classes:

ActionGraphEvent, ActionGraphEvent.Cache, ActionGraphEvent.Cache.Hit, ActionGraphEvent.Cache.Miss, ActionGraphEvent.Cache.MissWithEmptyCache, ActionGraphEvent.Cache.MissWithTargetGraphDifference, ActionGraphEvent.Cache.MissWithTargetGraphHashMatch, ActionGraphEvent.Finished, ActionGraphEvent.IncrementalLoad, ActionGraphEvent.Started, ArtifactCacheConnectEvent, ArtifactCacheConnectEvent.Finished, ArtifactCacheConnectEvent.Started, ArtifactCacheEvent, ArtifactCacheEvent.Finished, ArtifactCacheEvent.Started, ArtifactCompressionEvent, ArtifactCompressionEvent.Finished, ArtifactCompressionEvent.Started, BuildRuleEvent.FinishedRuleKeyCalc, BuildRuleEvent.StartedRuleKeyCalc, DirArtifactCacheEvent.Finished, DirArtifactCacheEvent.Started, FileHashCacheEvent, FileHashCacheEvent.InvalidationFinished, FileHashCacheEvent.InvalidationStarted, HttpArtifactCacheEvent, HttpArtifactCacheEvent.Finished, HttpArtifactCacheEvent.Scheduled, HttpArtifactCacheEvent.Started, InstallEvent, InstallEvent.Finished, InstallEvent.Started, LeafEvents.SimpleLeafEvent, LeafEvents.SimpleLeafEvent.Finished, LeafEvents.SimpleLeafEvent.Started, ParseEvent, ParseEvent.Finished, ParseEvent.Started, ProjectBuildFileParseEvents, ProjectBuildFileParseEvents.Finished, ProjectBuildFileParseEvents.Started, RuleKeyCalculationEvent.DefaultFinished, RuleKeyCalculationEvent.DefaultStarted, RuleKeyCalculationEvent.Event, SQLiteArtifactCacheEvent.Finished, SQLiteArtifactCacheEvent.Started, StartActivityEvent, StartActivityEvent.Finished, StartActivityEvent.Started, StepEvent, StepEvent.Finished, StepEvent.Started, TestStatusMessageEvent, TestStatusMessageEvent.Finished, TestStatusMessageEvent.Started, TestSummaryEvent, TestSummaryEvent.Finished, TestSummaryEvent.Started, UninstallEvent, UninstallEvent.Finished, UninstallEvent.Started, VersionedTargetGraphEvent, VersionedTargetGraphEvent.Cache, VersionedTargetGraphEvent.Cache.Hit, VersionedTargetGraphEvent.Cache.Miss, VersionedTargetGraphEvent.Finished, VersionedTargetGraphEvent.Started, VersionedTargetGraphEvent.Timeout

public interface LeafEvent
extends BuckEvent

LeafEvents represent events that have no logical children and are useful for tracking the time buck is spending logically grouped by categories, such as Parse, Javac, or Dx. An example of something that wouldn't be a good candidate for a LeafEvent would be a RuleEvent since we're not spending an appreciable amount of time in the rules but in the steps instead.

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

Method Summary

Modifier and Type	Method and Description
String	getCategory()

Methods inherited from interface com.facebook.buck.event.BuckEvent

configure, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, isConfigured, isRelatedTo, toLogMessage

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

getEventName, getTimestampMillis, storeLastInstanceAndReplayForNewClients

Method Detail

getCategory

String getCategory()

Returns:

The category time spent in this event should be accounted under.