com.facebook.buck.remoteexecution.event

Class RemoteExecutionActionEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

com.facebook.buck.remoteexecution.event.RemoteExecutionActionEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface, WorkAdvanceEvent

Direct Known Subclasses:

RemoteExecutionActionEvent.Finished, RemoteExecutionActionEvent.InputsUploaded, RemoteExecutionActionEvent.Scheduled, RemoteExecutionActionEvent.Started, RemoteExecutionActionEvent.Terminal

public abstract class RemoteExecutionActionEvent
extends AbstractBuckEvent
implements WorkAdvanceEvent

Tracks events related to Remote Execution Actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteExecutionActionEvent.Finished An action just exited from this state.
static class	RemoteExecutionActionEvent.InputsUploaded Describes the event which occurs right after inputs were uploaded to the CAS.
static class	RemoteExecutionActionEvent.Scheduled Indicates that a remote execution event has been scheduled.
static class	RemoteExecutionActionEvent.Started An action just moved into this state.
static class	RemoteExecutionActionEvent.State The current state of a Remote Execution Actions.
static class	RemoteExecutionActionEvent.Terminal Sends a one off terminal event for a Remote Execution Action.

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

Modifier	Constructor and Description
protected	RemoteExecutionActionEvent(EventKey eventKey)

Method Summary

Modifier and Type	Method and Description
static String	actionDigestToString(Protocol.Digest actionDigest)
String	getEventName()
static boolean	isTerminalState(RemoteExecutionActionEvent.State state)
static Scope	sendEvent(BuckEventBus eventBus, RemoteExecutionActionEvent.State state, BuildRule buildRule, Optional<Protocol.Digest> actionDigest) Takes care of sending both Started and Finished events within a Scope.
static void	sendInputsUploadedEventIfNeed(BuckEventBus eventBus, BuildRule buildRule, List<RemoteExecutionActionEvent.InputsUploaded.LargeBlob> largeBlobs) Sending the InputsUploaded event
static void	sendScheduledEvent(BuckEventBus eventBus, BuildRule buildRule)
static void	sendTerminalEvent(BuckEventBus eventBus, RemoteExecutionActionEvent.State state, BuildRule buildRule, Optional<Protocol.Digest> actionDigest, Optional<build.bazel.remote.execution.v2.ExecutedActionMetadata> executedActionMetadata, Optional<com.facebook.buck.remoteexecution.proto.RemoteExecutionMetadata> remoteExecutionMetadata, Optional<Map<RemoteExecutionActionEvent.State,Long>> stateMetadata, Optional<Map<RemoteExecutionActionEvent.State,Long>> stateWaitingMetadata, io.grpc.Status grpcStatus, RemoteExecutionActionEvent.State lastNonTerminalState, OptionalInt exitCode) Sends the terminal event of an action [FAIL|SUCCESS].

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

configure, equals, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, getTimestampMillis, getValueString, 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.BuckEvent

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

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

getTimestampMillis, storeLastInstanceAndReplayForNewClients

Constructor Detail

RemoteExecutionActionEvent

protected RemoteExecutionActionEvent(EventKey eventKey)

Method Detail

sendEvent

public static Scope sendEvent(BuckEventBus eventBus,
                              RemoteExecutionActionEvent.State state,
                              BuildRule buildRule,
                              Optional<Protocol.Digest> actionDigest)

Takes care of sending both Started and Finished events within a Scope.

sendTerminalEvent

public static void sendTerminalEvent(BuckEventBus eventBus,
                                     RemoteExecutionActionEvent.State state,
                                     BuildRule buildRule,
                                     Optional<Protocol.Digest> actionDigest,
                                     Optional<build.bazel.remote.execution.v2.ExecutedActionMetadata> executedActionMetadata,
                                     Optional<com.facebook.buck.remoteexecution.proto.RemoteExecutionMetadata> remoteExecutionMetadata,
                                     Optional<Map<RemoteExecutionActionEvent.State,Long>> stateMetadata,
                                     Optional<Map<RemoteExecutionActionEvent.State,Long>> stateWaitingMetadata,
                                     io.grpc.Status grpcStatus,
                                     RemoteExecutionActionEvent.State lastNonTerminalState,
                                     OptionalInt exitCode)

Sends the terminal event of an action [FAIL|SUCCESS].

sendScheduledEvent

public static void sendScheduledEvent(BuckEventBus eventBus,
                                      BuildRule buildRule)

sendInputsUploadedEventIfNeed

public static void sendInputsUploadedEventIfNeed(BuckEventBus eventBus,
                                                 BuildRule buildRule,
                                                 List<RemoteExecutionActionEvent.InputsUploaded.LargeBlob> largeBlobs)

Sending the InputsUploaded event

isTerminalState

public static boolean isTerminalState(RemoteExecutionActionEvent.State state)

getEventName

public String getEventName()

Specified by:

getEventName in interface BuckEventExternalInterface

Returns:

the type of the event.

actionDigestToString

public static String actionDigestToString(Protocol.Digest actionDigest)