package build_event_stream

Get desktop application:
View/edit binary Protocol Buffers messages

Payload of an event indicating that an expected event will not come, as the build is aborted prematurely for some reason.

Used in: BuildEvent

• Aborted.AbortReason reason = 1

• string description = 2

  A human readable description with more details about there reason, where available and useful.

Used in: Aborted

• UNKNOWN = 0

• USER_INTERRUPTED = 1

  The user requested the build to be aborted (e.g., by hitting Ctl-C).

• NO_ANALYZE = 8

  The user requested that no analysis be performed.

• NO_BUILD = 9

  The user requested that no build be carried out.

• TIME_OUT = 2

  The build or target was aborted as a timeout was exceeded.

• REMOTE_ENVIRONMENT_FAILURE = 3

  The build or target was aborted as some remote environment (e.g., for remote execution of actions) was not available in the expected way.

• INTERNAL = 4

  Failure due to reasons entirely internal to the build tool, e.g., running out of memory.

• LOADING_FAILURE = 5

  A Failure occurred in the loading phase of a target.

• ANALYSIS_FAILURE = 6

  A Failure occurred in the analysis phase of a target.

• SKIPPED = 7

  Target build was skipped (e.g. due to incompatible CPU constraints).

Payload of the event indicating the completion of an action. The main purpose of posting those events is to provide details on the root cause for a target failing; however, consumers of the build-event protocol must not assume that only failed actions are posted.

Used in: BuildEvent

• bool success = 1

• string type = 8

  The mnemonic of the action that was executed

• int32 exit_code = 2

  The exit code of the action, if it is available.

• optional File stdout = 3

  Location where to find the standard output of the action (e.g., a file path).

• optional File stderr = 4

  Location where to find the standard error of the action (e.g., a file path).

• string label = 5

  Deprecated. This field is now present on ActionCompletedId.

• optional BuildEventId.ConfigurationId configuration = 7

  Deprecated. This field is now present on ActionCompletedId.

• optional File primary_output = 6

  Primary output; only provided for successful actions.

• repeated string command_line = 9

  The command-line of the action, if the action is a command.

Message describing a build event. Events will have an identifier that is unique within a given build invocation; they also announce follow-up events as children. More details, which are specific to the kind of event that is observed, is provided in the payload. More options for the payload might be added in the future.

• optional BuildEventId id = 1

• repeated BuildEventId children = 2

• bool last_message = 20

• oneof payload

  • Progress progress = 3

  • Aborted aborted = 4

  • BuildStarted started = 5

  • UnstructuredCommandLine unstructured_command_line = 12

  • command_line.CommandLine structured_command_line = 22

  • OptionsParsed options_parsed = 13

  • WorkspaceStatus workspace_status = 16

  • Fetch fetch = 21

  • Configuration configuration = 17

  • PatternExpanded expanded = 6

  • TargetConfigured configured = 18

  • ActionExecuted action = 7

  • NamedSetOfFiles named_set_of_files = 15

  • TargetComplete completed = 8

  • TestResult test_result = 10

  • TestSummary test_summary = 9

  • BuildFinished finished = 14

  • BuildToolLogs build_tool_logs = 23

  • BuildMetrics build_metrics = 24

Identifier for a build event. It is deliberately structured to also provide information about which build target etc the event is related to. Events are chained via the event id as follows: each event has an id and a set of ids of children events such that apart from the initial event each event has an id that is mentioned as child id in an earlier event and a build invocation is complete if and only if all direct and indirect children of the initial event have been posted.

Used in: BuildEvent

• oneof id

  • BuildEventId.UnknownBuildEventId unknown = 1

  • BuildEventId.ProgressId progress = 2

  • BuildEventId.BuildStartedId started = 3

  • BuildEventId.UnstructuredCommandLineId unstructured_command_line = 11

  • BuildEventId.StructuredCommandLineId structured_command_line = 18

  • BuildEventId.WorkspaceStatusId workspace_status = 14

  • BuildEventId.OptionsParsedId options_parsed = 12

  • BuildEventId.FetchId fetch = 17

  • BuildEventId.ConfigurationId configuration = 15

  • BuildEventId.TargetConfiguredId target_configured = 16

  • BuildEventId.PatternExpandedId pattern = 4

  • BuildEventId.PatternExpandedId pattern_skipped = 10

  • BuildEventId.NamedSetOfFilesId named_set = 13

  • BuildEventId.TargetCompletedId target_completed = 5

  • BuildEventId.ActionCompletedId action_completed = 6

  • BuildEventId.UnconfiguredLabelId unconfigured_label = 19

  • BuildEventId.ConfiguredLabelId configured_label = 21

  • BuildEventId.TestResultId test_result = 8

  • BuildEventId.TestSummaryId test_summary = 7

  • BuildEventId.BuildFinishedId build_finished = 9

  • BuildEventId.BuildToolLogsId build_tool_logs = 20

  • BuildEventId.BuildMetricsId build_metrics = 22

Identifier of an event reporting that an action was completed (not all actions are reported, only the ones that can be considered important; this includes all failed actions).

Used in: BuildEventId

• string primary_output = 1

• string label = 2

  Optional, the label of the owner of the action, for reference.

• optional ConfigurationId configuration = 3

  Optional, the id of the configuration of the action owner.

Identifier of the BuildFinished event, indicating the end of a build.

Used in: BuildEventId

(message has no fields)

Identifier of an event providing build metrics after completion of the build.

Used in: BuildEventId

(message has no fields)

Identifier of an event indicating the beginning of a build; this will normally be the first event.

Used in: BuildEventId

(message has no fields)

Identifier of an event providing additional logs/statistics after completion of the build.

Used in: BuildEventId

(message has no fields)

Identifier of an event introducing a configuration.

Used in: ActionExecuted, BuildEventId, ActionCompletedId, ConfiguredLabelId, TargetCompletedId, TestResultId, TestSummaryId

• string id = 1

  Identifier of the configuration; users of the protocol should not make any assumptions about it having any structure, or equality of the identifier between different streams.

Identifier of an event reporting an event associated with a configured label, usually a visibility error. In any case, an event with such an id will always report some form of error (i.e., the payload will be an Aborted event); there are no regular events using this identifier.

Used in: BuildEventId

• string label = 1

• optional ConfigurationId configuration = 2

Identifier of an event reporting that an external resource was fetched from.

Used in: BuildEventId

• string url = 1

  The external resource that was fetched from.

Identifier of an event introducing a named set of files (usually artifacts) to be referred to in later messages.

Used in: BuildEventId, NamedSetOfFiles, OutputGroup

• string id = 1

  Identifier of the file set; this is an opaque string valid only for the particular instance of the event stream.

Identifier on an event reporting on the options included in the command line, both explicitly and implicitly.

Used in: BuildEventId

(message has no fields)

Identifier of an event indicating that a target pattern has been expanded further. Messages of this shape are also used to describe parts of a pattern that have been skipped for some reason, if the actual expansion was still carried out (e.g., if keep_going is set). In this case, the pattern_skipped choice in the id field is to be made.

Used in: BuildEventId

• repeated string pattern = 1

Identifier of an event reporting progress. Those events are also used to chain in events that come early.

Used in: BuildEventId

• int32 opaque_count = 1

  Unique identifier. No assumption should be made about how the ids are assigned; the only meaningful operation on this field is test for equality.

Identifier on an event describing the commandline received by Bazel.

Used in: BuildEventId

• string command_line_label = 1

  A title for this command line value, as there may be multiple. For example, a single invocation may wish to report both the literal and canonical command lines, and this label would be used to differentiate between both versions.

Identifier of an event indicating that a target was built completely; this does not include running the test if the target is a test target.

Used in: BuildEventId

• string label = 1

• optional ConfigurationId configuration = 3

  The configuration for which the target was built.

• string aspect = 2

  If not empty, the id refers to the completion of the target for a given aspect.

Identifier of an event indicating that a target has been expanded by identifying for which configurations it should be build.

Used in: BuildEventId

• string label = 1

• string aspect = 2

  If not empty, the id refers to the expansion of the target for a given aspect.

Identifier of an event reporting on an individual test run. The label identifies the test that is reported about, the remaining fields are in such a way as to uniquely identify the action within a build. In fact, attempts for the same test, run, shard triple are counted sequentially, starting with 1.

Used in: BuildEventId

• string label = 1

• optional ConfigurationId configuration = 5

• int32 run = 2

• int32 shard = 3

• int32 attempt = 4

Identifier of an event reporting the summary of a test.

Used in: BuildEventId

• string label = 1

• optional ConfigurationId configuration = 2

Identifier of an event reporting an event associated with an unconfigured label. Usually, this indicates a failure due to a missing input file. In any case, it will report some form of error (i.e., the payload will be an Aborted event); there are no regular events using this identifier. The purpose of those events is to serve as the root cause of a failed target.

Used in: BuildEventId

• string label = 1

Generic identifier for a build event. This is the default type of BuildEventId, but should not be used outside testing; nevertheless, tools should handle build events with this kind of id gracefully.

Used in: BuildEventId

• string details = 1

Identifier on an event indicating the original commandline received by the bazel server.

Used in: BuildEventId

(message has no fields)

Identifier of an event indicating the workspace status.

Used in: BuildEventId

(message has no fields)

Event indicating the end of a build.

Used in: BuildEvent

• bool overall_success = 1

  If the build succeeded or failed.

• optional BuildFinished.ExitCode exit_code = 3

  The overall status of the build. A build was successful iff ExitCode.code equals 0.

• int64 finish_time_millis = 2

  Time in milliseconds since the epoch. TODO(buchgr): Use google.protobuf.Timestamp once bazel's protoc supports it.

Exit code of a build. The possible values correspond to the predefined codes in bazel's lib.ExitCode class, as well as any custom exit code a module might define. The predefined exit codes are subject to change (but rarely do) and are not part of the public API. A build was successful iff ExitCode.code equals 0.

Used in: BuildFinished

• string name = 1

  The name of the exit code.

• int32 code = 2

  The exit code.

Used in: BuildEvent

• optional BuildMetrics.ActionSummary action_summary = 1

• optional BuildMetrics.MemoryMetrics memory_metrics = 2

• optional BuildMetrics.TargetMetrics target_metrics = 3

• optional BuildMetrics.PackageMetrics package_metrics = 4

Used in: BuildMetrics

• int64 actions_created = 1

  The total number of actions created and registered during the build. This includes unused actions that were constructed but not executed during this build.

• int64 actions_executed = 2

  The total number of actions executed during the build. This includes any remote cache hits, but excludes local action cache hits.

Used in: BuildMetrics

• int64 used_heap_size_post_build = 1

  Size of the JVM heap post build in bytes. This is only collected if --bep_publish_used_heap_size_post_build is set, since it forces a full GC.

Used in: BuildMetrics

• int64 packages_loaded = 1

  Number of BUILD files (aka packages) loaded during this build.

Used in: BuildMetrics

• int64 targets_loaded = 1

  Number of targets loaded during this build.

• int64 targets_configured = 2

  Number of targets configured during this build. This can be greater than targets_loaded if the same target is configured multiple times.

Payload of an event indicating the beginning of a new build. Usually, events of those type start a new build-event stream. The target pattern requested to be build is contained in one of the announced child events; it is an invariant that precisely one of the announced child events has a non-empty target pattern.

Used in: BuildEvent

• string uuid = 1

• int64 start_time_millis = 2

  Start of the build in ms since the epoch. TODO(buchgr): Use google.protobuf.TimeStamp once bazel's protoc supports it.

• string build_tool_version = 3

  Version of the build tool that is running.

• string options_description = 4

  A human-readable description of all the non-default option settings

• string command = 5

  The name of the command that the user invoked.

• string working_directory = 6

  The working directory from which the build tool was invoked.

• string workspace_directory = 7

  The directory of the workspace.

• int64 server_pid = 8

  The process ID of the Bazel server.

Event providing additional statistics/logs after completion of the build.

Used in: BuildEvent

• repeated File log = 1

Payload of an event reporting details of a given configuration.

Used in: BuildEvent

• string mnemonic = 1

• string platform_name = 2

• string cpu = 3

• map<string, string> make_variable = 4

Payload of an event indicating that an external resource was fetched. This event will only occur in streams where an actual fetch happened, not in ones where a cached copy of the entity to be fetched was used.

Used in: BuildEvent

• bool success = 1

Used in: ActionExecuted, BuildToolLogs, NamedSetOfFiles, TargetComplete, TestResult, TestSummary

• string name = 1

  identifier indicating the nature of the file (e.g., "stdout", "stderr")

• oneof file

  • string uri = 2

    A location where the contents of the file can be found. The string is encoded according to RFC2396.

  • bytes contents = 3

    The contents of the file, if they are guaranteed to be short.

Payload of a message to describe a set of files, usually build artifacts, to be referred to later by their name. In this way, files that occur identically as outputs of several targets have to be named only once.

Used in: BuildEvent

• repeated File files = 1

  Files that belong to this named set of files.

• repeated BuildEventId.NamedSetOfFilesId file_sets = 2

  Other named sets whose members also belong to this set.

Payload of an event reporting on the parsed options, grouped in various ways.

Used in: BuildEvent

• repeated string startup_options = 1

• repeated string explicit_startup_options = 2

• repeated string cmd_line = 3

• repeated string explicit_cmd_line = 4

• optional blaze.invocation_policy.InvocationPolicy invocation_policy = 5

• string tool_tag = 6

Collection of all output files belonging to that output group.

Used in: TargetComplete

• string name = 1

  Name of the output group

• repeated BuildEventId.NamedSetOfFilesId file_sets = 3

  List of file sets that belong to this output group as well.

Payload of the event indicating the expansion of a target pattern. The main information is in the chaining part: the id will contain the target pattern that was expanded and the children id will contain the target or target pattern it was expanded to.

Used in: BuildEvent

(message has no fields)

Payload of an event summarizing the progress of the build so far. Those events are also used to be parents of events where the more logical parent event cannot be posted yet as the needed information is not yet complete.

Used in: BuildEvent

• string stdout = 1

  The next chunk of stdout that bazel produced since the last progress event or the beginning of the build.

• string stderr = 2

  The next chunk of stderr that bazel produced since the last progress event or the beginning of the build.

Payload of the event indicating the completion of a target. The target is specified in the id. If the target failed the root causes are provided as children events.

Used in: BuildEvent

• bool success = 1

• string target_kind = 5

  The kind of target (e.g., e.g. "cc_library rule", "source file", "generated file") where the completion is reported. Deprecated: use the target_kind field in TargetConfigured instead.

• TestSize test_size = 6

  The size of the test, if the target is a test target. Unset otherwise. Deprecated: use the test_size field in TargetConfigured instead.

• repeated OutputGroup output_group = 2

  The output files are arranged by their output group. If an output file is part of multiple output groups, it appears once in each output group.

• repeated File important_output = 4

  Temporarily, also report the important outputs directly. This is only to allow existing clients help transition to the deduplicated representation; new clients should not use it.

• repeated string tag = 3

  List of tags associated with this configured target.

• int64 test_timeout_seconds = 7

  The timeout specified for test actions under this configured target.

Payload of the event indicating that the configurations for a target have been identified. As with pattern expansion the main information is in the chaining part: the id will contain the target that was configured and the children id will contain the configured targets it was configured to.

Used in: BuildEvent

• string target_kind = 1

  The kind of target (e.g., e.g. "cc_library rule", "source file", "generated file") where the completion is reported.

• TestSize test_size = 2

  The size of the test, if the target is a test target. Unset otherwise.

• repeated string tag = 3

  List of all tags associated with this target (for all possible configurations).

Payload on events reporting about individual test action.

Used in: BuildEvent

• TestStatus status = 5

  The status of this test.

• string status_details = 9

  Additional details about the status of the test. This is intended for user display and must not be parsed.

• bool cached_locally = 4

  True, if the reported attempt is taken from the tool's local cache.

• int64 test_attempt_start_millis_epoch = 6

  Time in milliseconds since the epoch at which the test attempt was started. Note: for cached test results, this is time can be before the start of the build.

• int64 test_attempt_duration_millis = 3

  Time the test took to run. For locally cached results, this is the time the cached invocation took when it was invoked.

• repeated File test_action_output = 2

  Files (logs, test.xml, undeclared outputs, etc) generated by that test action.

• repeated string warning = 7

  Warnings generated by that test action.

• optional TestResult.ExecutionInfo execution_info = 8

Message providing optional meta data on the execution of the test action, if available.

Used in: TestResult

• int32 timeout_seconds = 1

  Deprecated, use TargetComplete.test_timeout_seconds instead.

• string strategy = 2

  Name of the strategy to execute this test action (e.g., "local", "remote")

• bool cached_remotely = 6

  True, if the reported attempt was a cache hit in a remote cache.

• int32 exit_code = 7

  The exit code of the test action.

• string hostname = 3

  The hostname of the machine where the test action was executed (in case of remote execution), if known.

• optional ExecutionInfo.TimingBreakdown timing_breakdown = 4

• repeated ExecutionInfo.ResourceUsage resource_usage = 5

Used in: ExecutionInfo

• string name = 1

• int64 value = 2

Represents a hierarchical timing breakdown of an activity. The top level time should be the total time of the activity. Invariant: time_millis >= sum of time_millis of all direct children.

Used in: ExecutionInfo

• repeated TimingBreakdown child = 1

• string name = 2

• int64 time_millis = 3

Enumeration type characterizing the size of a test, as specified by the test rule.

Used in: TargetComplete, TargetConfigured

• UNKNOWN = 0

• SMALL = 1

• MEDIUM = 2

• LARGE = 3

• ENORMOUS = 4

Used in: TestResult, TestSummary

• NO_STATUS = 0

• PASSED = 1

• FLAKY = 2

• TIMEOUT = 3

• FAILED = 4

• INCOMPLETE = 5

• REMOTE_FAILURE = 6

• FAILED_TO_BUILD = 7

• TOOL_HALTED_BEFORE_TESTING = 8

Payload of the event summarizing a test. TODO(aehlig): extend event with additional information as soon as we known which additional information we need for test summaries.

Used in: BuildEvent

• TestStatus overall_status = 5

  Wrapper around BlazeTestStatus to support importing that enum to proto3. Overall status of test, accumulated over all runs, shards, and attempts.

• int32 total_run_count = 1

  Total number of runs

• repeated File passed = 3

  Path to logs of passed runs.

• repeated File failed = 4

  Path to logs of failed runs;

• int32 total_num_cached = 6

  Total number of cached test actions

Payload of an event reporting the command-line of the invocation as originally received by the server. Note that this is not the command-line given by the user, as the client adds information about the invocation, like name and relevant entries of rc-files and client environment variables. However, it does contain enough information to reproduce the build invocation.

Used in: BuildEvent

• repeated string args = 1

Payload of an event reporting the workspace status. Key-value pairs can be provided by specifying the workspace_status_command to an executable that returns one key-value pair per line of output (key and value separated by a space).

Used in: BuildEvent

• repeated WorkspaceStatus.Item item = 1

Used in: WorkspaceStatus

• string key = 1

• string value = 2