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, i.e. an unexpected crash due to programmer error.

• 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).

• INCOMPLETE = 10

  Build incomplete due to an earlier build failure (e.g. --keep_going was set to false causing the build be ended upon failure).

• OUT_OF_MEMORY = 11

  The build tool ran out of memory and crashed.

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.

• repeated File action_metadata_logs = 10

  List of paths to log files

• optional failure_details.FailureDetail failure_detail = 11

  Only populated if success = false, and sometimes not even then.

• optional google.protobuf.Timestamp start_time = 12

  Start of action execution, before any attempted execution begins.

• optional google.protobuf.Timestamp end_time = 13

  End of action execution, after all attempted execution completes.

• repeated google.protobuf.Any strategy_details = 14

  Additional details about action execution supplied by strategies. Bazel options will determine which strategy details are included when multiple strategies are involved in a single action's execution. The default type will be `tools.proto.SpawnExec` found in `spawn.proto`.

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

  • TestProgress test_progress = 30

  • TestSummary test_summary = 9

  • TargetSummary target_summary = 28

  • BuildFinished finished = 14

  • BuildToolLogs build_tool_logs = 23

  • BuildMetrics build_metrics = 24

  • WorkspaceConfig workspace_info = 25

  • BuildMetadata build_metadata = 26

  • ConvenienceSymlinksIdentified convenience_symlinks_identified = 27

  • ExecRequestConstructed exec_request = 29

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.TestProgressId test_progress = 29

  • BuildEventId.TestSummaryId test_summary = 7

  • BuildEventId.TargetSummaryId target_summary = 26

  • BuildEventId.BuildFinishedId build_finished = 9

  • BuildEventId.BuildToolLogsId build_tool_logs = 20

  • BuildEventId.BuildMetricsId build_metrics = 22

  • BuildEventId.WorkspaceConfigId workspace = 23

  • BuildEventId.BuildMetadataId build_metadata = 24

  • BuildEventId.ConvenienceSymlinksIdentifiedId convenience_symlinks_identified = 25

  • BuildEventId.ExecRequestId exec_request = 28

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)

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, TargetSummaryId, TestProgressId, 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. A value of "none" means the null configuration. It is used for targets that are not configurable, for example, source files.

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 providing convenience symlinks information.

Used in: BuildEventId

(message has no fields)

Identifier of an event providing the ExecRequest of a run command.

Used in: BuildEventId

(message has no fields)

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 empty, the id refers to the completion of the target. If not-empty, the id refers to the completion of an aspect applied to the (already completed) target. For example, when building an apple_binary that depends on proto_library "//:foo_proto", there will be two TargetCompleted events for "//:foo_proto": 1. An event with an empty aspect, corresponding to actions producing language-agnostic outputs from the proto_library; and 2. An event with aspect "ObjcProtoAspect", corresponding to Objective-C code generation.

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 empty, the id refers to the expansion of the target. If not-empty, the id refers to the expansion of an aspect applied to the (already expanded) target. For example, when building an apple_binary that depends on proto_library "//:foo_proto", there will be two TargetConfigured events for "//:foo_proto": 1. An event with an empty aspect, corresponding to actions producing language-agnostic outputs from the proto_library; and 2. An event with aspect "ObjcProtoAspect", corresponding to Objective-C code generation.

Identifier of an event reporting the summary of a target.

Used in: BuildEventId

• string label = 1

• optional ConfigurationId configuration = 2

Identifier of an event reporting progress of an individual test run.

Used in: BuildEventId

• string label = 1

  The label of the target for the action.

• optional ConfigurationId configuration = 2

  The configuration under which the action is running.

• int32 run = 3

  The run number of the test action (e.g. for runs_per_test > 1).

• int32 shard = 4

  For sharded tests, the shard number of the test action.

• int32 attempt = 5

  The execution attempt number which may increase due to retries (e.g. for flaky tests).

• int32 opaque_count = 6

  An incrementing count used to differentiate TestProgressIds for the same test attempt.

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)

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

  End of the build in ms since the epoch. Deprecated, use `finish_time` instead. TODO(yannic): Remove.

• optional google.protobuf.Timestamp finish_time = 5

  End of the build.

• optional BuildFinished.AnomalyReport anomaly_report = 4

• optional failure_details.FailureDetail failure_detail = 6

  Only populated if success = false, and sometimes not even then.

Things that happened during the build that could be of interest.

Used in: BuildFinished

• bool was_suspended = 1

  Was the build suspended at any time during the build. Examples of suspensions are SIGSTOP, or the hardware being put to sleep. If was_suspended is true, then most of the timings for this build are suspect. NOTE: This is no longer set and is deprecated.

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.

Payload of an event reporting custom key-value metadata associated with the build.

Used in: BuildEvent

• map<string, string> metadata = 1

  Custom metadata for the build.

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

• optional BuildMetrics.TimingMetrics timing_metrics = 5

• optional BuildMetrics.CumulativeMetrics cumulative_metrics = 6

• optional BuildMetrics.ArtifactMetrics artifact_metrics = 7

• optional BuildMetrics.BuildGraphMetrics build_graph_metrics = 8

• repeated BuildMetrics.WorkerMetrics worker_metrics = 9

• optional BuildMetrics.NetworkMetrics network_metrics = 10

• optional BuildMetrics.WorkerPoolMetrics worker_pool_metrics = 11

• optional BuildMetrics.DynamicExecutionMetrics dynamic_execution_metrics = 12

Used in: BuildMetrics

• int64 actions_created = 1

  The total number of actions created and registered during the build, including both aspects and configured targets. This metric includes unused actions that were constructed but not executed during this build. It does not include actions that were created on prior builds that are still valid, even if those actions had to be re-executed on this build. For the total number of actions that would be created if this invocation were "clean", see BuildGraphMetrics below.

• int64 actions_created_not_including_aspects = 3

  The total number of actions created this build just by configured targets. Used mainly to allow consumers of actions_created, which used to not include aspects' actions, to normalize across the Blaze release that switched actions_created to include all created actions.

• 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.

• repeated ActionSummary.ActionData action_data = 4

  Contains the top N actions by number of actions executed.

• int64 remote_cache_hits = 5

  Deprecated. The total number of remote cache hits.

• repeated ActionSummary.RunnerCount runner_count = 6

• optional blaze.ActionCacheStatistics action_cache_statistics = 7

Used in: ActionSummary

• string mnemonic = 1

• int64 actions_executed = 2

  The total number of actions of this type executed during the build. As above, includes remote cache hits but excludes local action cache hits.

• int64 first_started_ms = 3

  When the first action of this type started being executed, in milliseconds from the epoch.

• int64 last_ended_ms = 4

  When the last action of this type ended being executed, in milliseconds from the epoch.

• optional google.protobuf.Duration system_time = 5

  Accumulated CPU time of all spawned actions of this type. This is only set if all the actions reported a time

• optional google.protobuf.Duration user_time = 6

• int64 actions_created = 7

  The total number of actions of this type registered during the build.

Used in: ActionSummary

• string name = 1

• int32 count = 2

• string exec_kind = 3

Used in: BuildMetrics

• optional ArtifactMetrics.FilesMetric source_artifacts_read = 2

  Measures all source files newly read this build. Does not include unchanged sources on incremental builds.

• optional ArtifactMetrics.FilesMetric output_artifacts_seen = 3

  Measures all output artifacts from executed actions. This includes actions that were cached locally (via the action cache) or remotely (via a remote cache or executor), but does *not* include outputs of actions that were cached internally in Skyframe.

• optional ArtifactMetrics.FilesMetric output_artifacts_from_action_cache = 4

  Measures all output artifacts from actions that were cached locally via the action cache. These artifacts were already present on disk at the start of the build. Does not include Skyframe-cached actions' outputs.

• optional ArtifactMetrics.FilesMetric top_level_artifacts = 5

  Measures all artifacts that belong to a top-level output group. Does not deduplicate, so if there are two top-level targets in this build that share an artifact, it will be counted twice.

Used in: ArtifactMetrics

• int64 size_in_bytes = 1

• int32 count = 2

Information about the size and shape of the build graph. Some fields may not be populated if Bazel was able to skip steps due to caching.

Used in: BuildMetrics

• int32 action_lookup_value_count = 1

  How many configured targets/aspects were in this build, including any that were analyzed on a prior build and are still valid. May not be populated if analysis phase was fully cached. Note: for historical reasons this includes input/output files and other configured targets that do not actually have associated actions.

• int32 action_lookup_value_count_not_including_aspects = 5

  How many configured targets alone were in this build: always at most action_lookup_value_count. Useful mainly for historical comparisons to TargetMetrics.targets_configured, which used to not count aspects. This also includes configured targets that do not have associated actions.

• int32 action_count = 2

  How many actions belonged to the configured targets/aspects above. It may not be necessary to execute all of these actions to build the requested targets. May not be populated if analysis phase was fully cached.

• int32 action_count_not_including_aspects = 6

  How many actions belonged to configured targets: always at most action_count. Useful mainly for historical comparisons to ActionMetrics.actions_created, which used to not count aspects' actions.

• int32 input_file_configured_target_count = 7

  How many "input file" configured targets there were: one per source file. Should agree with artifact_metrics.source_artifacts_read.count above,

• int32 output_file_configured_target_count = 8

  How many "output file" configured targets there were: output files that are targets (not implicit outputs).

• int32 other_configured_target_count = 9

  How many "other" configured targets there were (like alias, package_group, and other non-rule non-file configured targets).

• int32 output_artifact_count = 3

  How many artifacts are outputs of the above actions. May not be populated if analysis phase was fully cached.

• int32 post_invocation_skyframe_node_count = 4

  How many Skyframe nodes there are in memory at the end of the build. This may underestimate the number of nodes when running with memory-saving settings or with Skybuild, and may overestimate if there are nodes from prior evaluations still in the cache.

• repeated EvaluationStat dirtied_values = 10

  Number of SkyValues that were dirtied during the build. Dirtied nodes are those that transitively depend on a node that changed by itself (e.g. one representing a file in the file system)

• repeated EvaluationStat changed_values = 11

  Number of SkyValues that changed by themselves. For example, when a file on the file system changes, the SkyValue representing it will change.

• repeated EvaluationStat built_values = 12

  Number of SkyValues that were built. This means that they were evaluated and were found to have changed from their previous version.

• repeated EvaluationStat cleaned_values = 13

  Number of SkyValues that were evaluated and found clean, i.e. equal to their previous version.

• repeated EvaluationStat evaluated_values = 17

  Number of evaluations to build SkyValues. This includes restarted evaluations, which means there can be multiple evaluations per built SkyValue. Subtract built_values from this number to get the number of restarted evaluations.

• repeated BuildGraphMetrics.RuleClassCount rule_class = 14

• repeated BuildGraphMetrics.AspectCount aspect = 15

For SkyKeys whose function name is ASPECT break out that information

Used in: BuildGraphMetrics

• string key = 1

  Unique key for Aspect.

• string aspect_name = 2

  usually the same as above, but can differ in some cases.

• uint64 count = 3

  number of aspects created of this type.

• uint64 action_count = 4

  number of actions created by aspects of this type.

For SkyKeys in 'done values' where the SkyValue is of type RuleConfiguredTargetValue, we pull those out separately and report the ruleClass and action count.

Used in: BuildGraphMetrics

• string key = 1

  Unique key for the rule class.

• string rule_class = 2

  String name of the rule_class (not guaranteed unique)

• uint64 count = 3

  how many rule instances of this type were seen.

• uint64 action_count = 4

  how many actions were created by this rule class.

Used in: BuildMetrics

• int32 num_analyses = 11

  One-indexed number of "analyses" the server has run, including the current one. Will be incremented for every build/test/cquery/etc. command that reaches the analysis phase.

• int32 num_builds = 12

  One-indexed number of "builds" the server has run, including the current one. Will be incremented for every build/test/run/etc. command that reaches the execution phase.

Information about dynamic execution.

Used in: BuildMetrics

• repeated DynamicExecutionMetrics.RaceStatistics race_statistics = 1

  Race statistics grouped by mnemonic, local_name, remote_name.

Used in: DynamicExecutionMetrics

• string mnemonic = 1

  Mnemonic of the action.

• string local_runner = 2

  Name of runner of local branch.

• string remote_runner = 3

  Name of runner of remote branch.

• int32 local_wins = 4

  Number of wins of local branch in race.

• int32 remote_wins = 5

  Number of wins of remote branch in race.

Data about the evaluation of Skyfunctions.

Used in: BuildGraphMetrics

• string skyfunction_name = 1

  Name of the Skyfunction.

• int64 count = 2

  How many times a given operation was carried out on a Skyfunction.

Used in: BuildMetrics

• int64 used_heap_size_post_build = 1

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

• int64 peak_post_gc_heap_size = 2

  Size of the peak JVM heap size in bytes post GC. Note that this reports 0 if there was no major GC during the build.

• int64 peak_post_gc_tenured_space_heap_size = 4

  Size of the peak tenured space JVM heap size event in bytes post GC. Note that this reports 0 if there was no major GC during the build.

• repeated MemoryMetrics.GarbageMetrics garbage_metrics = 3

Used in: MemoryMetrics

• string type = 1

  Type of garbage collected, e.g. G1 Old Gen.

• int64 garbage_collected = 2

  Number of bytes of garbage of the given type collected during this invocation.

Information about host network.

Used in: BuildMetrics

• optional NetworkMetrics.SystemNetworkStats system_network_stats = 1

Information for all the network traffic going on on the host machine during the invocation.

Used in: NetworkMetrics

• uint64 bytes_sent = 1

  Total bytes sent during the invocation.

• uint64 bytes_recv = 2

  Total bytes received during the invocation.

• uint64 packets_sent = 3

  Total packets sent during the invocation.

• uint64 packets_recv = 4

  Total packets received during the invocation.

• uint64 peak_bytes_sent_per_sec = 5

  Peak bytes/sec sent during the invocation.

• uint64 peak_bytes_recv_per_sec = 6

  Peak bytes/sec received during the invocation.

• uint64 peak_packets_sent_per_sec = 7

  Peak packets/sec sent during the invocation.

• uint64 peak_packets_recv_per_sec = 8

  Peak packets/sec received during the invocation.

Used in: BuildMetrics

• int64 packages_loaded = 1

  Number of BUILD files (aka packages) successfully loaded during this build. [For Bazel binaries built at source states] Before Dec 2021, this value was the number of packages attempted to be loaded, for a particular definition of "attempted". After Dec 2021, this value would sometimes overcount because the same package could sometimes be attempted to be loaded multiple times due to memory pressure. After Feb 2022, this value is the number of packages successfully loaded.

• repeated devtools.build.lib.packages.metrics.PackageLoadMetrics package_load_metrics = 2

  Loading time metrics per package.

Used in: BuildMetrics

• int64 targets_loaded = 1

  DEPRECATED No longer populated. It never measured what it was supposed to (targets loaded): it counted targets that were analyzed even if the underlying package had not changed. TODO(janakr): rename and remove.

• int64 targets_configured = 2

  Number of targets/aspects configured during this build. Does not include targets/aspects that were configured on prior builds on this server and were cached. See BuildGraphMetrics below if you need that.

• int64 targets_configured_not_including_aspects = 3

  Number of configured targets analyzed during this build. Does not include aspects. Used mainly to allow consumers of targets_configured, which used to not include aspects, to normalize across the Blaze release that switched targets_configured to include aspects.

Used in: BuildMetrics

• int64 cpu_time_in_ms = 1

  For Skymeld, it's possible that analysis_phase_time_in_ms + execution_phase_time_in_ms >= wall_time_in_ms The CPU time in milliseconds consumed during this build.

• int64 wall_time_in_ms = 2

  The elapsed wall time in milliseconds during this build.

• int64 analysis_phase_time_in_ms = 3

  The elapsed wall time in milliseconds during the analysis phase. When analysis and execution phases are interleaved, this measures the elapsed time from the first analysis work to the last.

• int64 execution_phase_time_in_ms = 4

  The elapsed wall time in milliseconds during the execution phase. When analysis and execution phases are interleaved, this measures the elapsed time from the first action execution (excluding workspace status actions) to the last.

• int64 actions_execution_start_in_ms = 5

  The elapsed wall time in milliseconds until the first action execution started (excluding workspace status actions).

Information about all workers that were alive during the invocation.

Used in: BuildMetrics

• int32 worker_id = 1

  Deprecated. Use worker_ids instead of this field.

• repeated uint32 worker_ids = 8

  Ids of workers. Could be multiple in case of multiplex workers

• uint32 process_id = 2

  Worker process id. If there is no process for worker, equals to zero.

• string mnemonic = 3

  Mnemonic of running worker.

• bool is_multiplex = 4

  Multiplex or singleplex worker.

• bool is_sandbox = 5

  Using worker sandbox file system or not.

• bool is_measurable = 6

  TODO(b/300067854): Deprecate since all worker metrics should have their WorkerStats set.

• int64 worker_key_hash = 9

  Hash value of worker key. Needed to distinguish worker pools with same menmonic but with different worker keys.

• WorkerMetrics.WorkerStatus worker_status = 10

• optional failure_details.Worker.Code code = 12

• int64 actions_executed = 11

• int64 prior_actions_executed = 13

• repeated WorkerMetrics.WorkerStats worker_stats = 7

  Combined workers statistics.

Information collected from worker at some point.

Used in: WorkerMetrics

• int64 collect_time_in_ms = 1

  Epoch unix time of collection of metrics.

• int32 worker_memory_in_kb = 2

  Memory usage of worker process at the end of the build.

• int32 prior_worker_memory_in_kb = 4

  Memory usage of the worker process prior to the invocation.

• int64 last_action_start_time_in_ms = 3

  Epoch unix time of last action started on specific worker.

Used in: WorkerMetrics

• NOT_STARTED = 0

  Used to indicate a worker instance where the process has not been created yet. In reality this isn't logged, but leaving this here as a possible option in the future.

• ALIVE = 1

• KILLED_DUE_TO_MEMORY_PRESSURE = 2

• KILLED_UNKNOWN = 3

  Indicates that the worker process was killed due to a reason unknown to Bazel at the point of measurement; if a known cause (below) comes along later on, this field will be updated.

• KILLED_DUE_TO_INTERRUPTED_EXCEPTION = 4

• KILLED_DUE_TO_IO_EXCEPTION = 5

• KILLED_DUE_TO_USER_EXEC_EXCEPTION = 6

Information about worker pool actions.

Used in: BuildMetrics

• repeated WorkerPoolMetrics.WorkerPoolStats worker_pool_stats = 1

  Statistics of worker pool per worker pool hash. Basically it's a map from worker pool hash to statistics.

Used in: WorkerPoolMetrics

• int32 hash = 1

  Hash of worker pool these stats are for. Contains information about startup flags.

• string mnemonic = 2

  Mnemonic of workers these stats are for.

• int64 created_count = 3

  Number of workers created during a build.

• int64 destroyed_count = 4

  Number of workers destroyed during a build (sum of all workers destroyed by eviction, UserExecException, IoException, InterruptedException and unknown reasons below).

• int64 evicted_count = 5

  Number of workers evicted during a build.

• int64 user_exec_exception_destroyed_count = 6

  Number of workers destroyed due to UserExecExceptions.

• int64 io_exception_destroyed_count = 7

  Number of workers destroyed due to IoExceptions.

• int64 interrupted_exception_destroyed_count = 8

  Number of workers destroyed due to InterruptedExceptions.

• int64 unknown_destroyed_count = 9

  Number of workers destroyed due to an unknown reason.

• int64 alive_count = 10

  Number of workers alive at the end of the build.

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. Deprecated, use `start_time` instead. TODO(yannic): Remove.

• optional google.protobuf.Timestamp start_time = 9

  Start of the build.

• 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

• bool is_tool = 5

  Whether this configuration is used for building tools.

The message that contains what type of action to perform on a given path and target of a symlink.

Used in: ConvenienceSymlinksIdentified

• string path = 1

  The path of the symlink to be created or deleted, absolute or relative to the workspace, creating any directories necessary. If a symlink already exists at that location, then it should be replaced by a symlink pointing to the new target.

• ConvenienceSymlink.Action action = 2

  The operation we are performing on the symlink.

• string target = 3

  If action is CREATE, this is the target path (relative to the output base) that the symlink should point to. If action is DELETE, this field is not set.

Used in: ConvenienceSymlink

• UNKNOWN = 0

• CREATE = 1

  Indicates a symlink should be created, or overwritten if it already exists.

• DELETE = 2

  Indicates a symlink should be deleted if it already exists.

Event describing all convenience symlinks (i.e., workspace symlinks) to be created or deleted once the execution phase has begun. Note that this event does not say anything about whether or not the build tool actually executed these filesystem operations; it only says what logical operations should be performed. This event is emitted exactly once per build; if no symlinks are to be modified, the event is still emitted with empty contents.

Used in: BuildEvent

• repeated ConvenienceSymlink convenience_symlinks = 1

An environment variable provided by a run command after a successful build.

Used in: ExecRequestConstructed

• bytes name = 1

• bytes value = 2

Event that contains the ExecRequest of a run command announced only after a successful build and before trying to execute the requested command-line.

Used in: BuildEvent

• bytes working_directory = 1

• repeated bytes argv = 2

• repeated EnvironmentVariable environment_variable = 3

• repeated bytes environment_variable_to_clear = 4

• bool should_exec = 5

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, OutputGroup, TargetComplete, TestResult, TestSummary

• repeated string path_prefix = 4

  A sequence of prefixes to apply to the file name to construct a full path. In most but not all cases, there will be 3 entries: 1. A root output directory, eg "bazel-out" 2. A configuration mnemonic, eg "k8-fastbuild" 3. An output category, eg "genfiles"

• 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.

  • string symlink_target_path = 7

    The symlink target path, if the file is an unresolved symlink.

• string digest = 5

  Digest of the file, using the build tool's configured digest algorithm, hex-encoded.

• int64 length = 6

  Length of the file in bytes.

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.

• bool incomplete = 4

  Indicates that one or more of the output group's files were not built successfully (the generating action failed).

• repeated File inline_files = 5

  Inlined files that belong to this output group, requested via --build_event_inline_output_groups.

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

• repeated PatternExpanded.TestSuiteExpansion test_suite_expansions = 1

  All test suites requested via top-level target patterns. Does not include test suites whose label matched a negative pattern.

Represents a test_suite target and the tests that it expanded to. Nested test suites are recursively expanded. The test labels only contain the final test targets, not any nested suites.

Used in: PatternExpanded

• string suite_label = 1

  The label of the test_suite rule.

• repeated string test_labels = 2

  Labels of the test targets included in the suite. Includes all tests in the suite regardless of any filters or negative patterns which may result in the test not actually being run.

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. Consumers that need to reason about the relative order of stdout and stderr can assume that stderr has been emitted before stdout if both are present, on a best-effort basis.

• string stderr = 2

  The next chunk of stderr that bazel produced since the last progress event or the beginning of the build. Consumers that need to reason about the relative order of stdout and stderr can assume that stderr has been emitted before stdout if both are present, on a best-effort basis.

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 File directory_output = 8

  Report output artifacts (referenced transitively via output_group) which emit directories instead of singleton files. These directory_output entries will never include a uri.

• 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. Deprecated, use `test_timeout` instead. TODO(yannic): Remove.

• optional google.protobuf.Duration test_timeout = 10

  The timeout specified for test actions under this configured target.

• optional failure_details.FailureDetail failure_detail = 9

  Failure information about the target, only populated if success is false, and sometimes not even then. Equal to one of the ActionExecuted failure_detail fields for one of the root cause ActionExecuted events.

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 of the event summarizing a target (test or non-test).

Used in: BuildEvent

• bool overall_build_success = 1

  Conjunction of TargetComplete events for this target, including aspects.

• TestStatus overall_test_status = 2

  Repeats TestSummary's overall_status if available.

Event payload providing information about an active, individual test run.

Used in: BuildEvent

• string uri = 1

  Identifies a resource that may provide information about an active test run. The resource is not necessarily a file and may need to be queried for information. The URI is not guaranteed to be available after the test completes. The string is encoded according to RFC2396.

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. Deprecated, use `test_attempt_start` instead. TODO(yannic): Remove.

• optional google.protobuf.Timestamp test_attempt_start = 10

  Time 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. Deprecated, use `test_attempt_duration` instead. TODO(yannic): Remove.

• optional google.protobuf.Duration test_attempt_duration = 11

  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 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` >= sum of `time`s of all direct children.

Used in: ExecutionInfo

• repeated TimingBreakdown child = 1

• string name = 2

• int64 time_millis = 3

  Deprecated, use `time` instead. TODO(yannic): Remove.

• optional google.protobuf.Duration time = 4

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: TargetSummary, 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.

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 shard attempts. E.g., if a target has 4 runs, 3 shards, each with 2 attempts, then total_run_count will be 4*3*2 = 24.

• int32 run_count = 10

  Value of runs_per_test for the test.

• int32 attempt_count = 15

  Number of attempts. If there are a different number of attempts per shard, the highest attempt count across all shards for each run is used.

• int32 shard_count = 11

  Number of shards.

• 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

• int64 first_start_time_millis = 7

  When the test first started running. Deprecated, use `first_start_time` instead. TODO(yannic): Remove.

• optional google.protobuf.Timestamp first_start_time = 13

  When the test first started running.

• int64 last_stop_time_millis = 8

  When the last test action completed. Deprecated, use `last_stop_time` instead. TODO(yannic): Remove.

• optional google.protobuf.Timestamp last_stop_time = 14

  When the test first started running.

• int64 total_run_duration_millis = 9

  The total runtime of the test. Deprecated, use `total_run` instead. TODO(yannic): Remove.

• optional google.protobuf.Duration total_run_duration = 12

  The total runtime of the test.

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

Configuration related to the blaze workspace and output tree.

Used in: BuildEvent

• string local_exec_root = 1

  The root of the local blaze exec root. All output files live underneath this at "blaze-out/".

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