此页面由 Cloud Translation API 翻译。

Build Event Protocol 术语表

每种 BEP 事件类型都有自己的语义，至少在 build_event_stream.proto 中有所记录。以下术语表介绍了每种事件类型。

已中止

与其他事件不同，Aborted 没有对应的 ID 类型，因为 Aborted 事件会替换其他类型的事件。此事件表示 build 提前终止，且其出现的事件 ID 并非正常生成。Aborted 包含枚举和易于理解的说明，用于解释构建未完成的原因。

例如，如果构建要在用户中断 Bazel 时评估目标，BEP 会包含如下事件：

{
  "id": {
    "targetCompleted": {
      "label": "//:foo",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      }
    }
  },
  "aborted": {
    "reason": "USER_INTERRUPTED"
  }
}

ActionExecuted

提供有关在 build 中执行特定操作的详细信息。默认情况下，仅针对失败的操作将此事件包含在 BEP 中，以帮助确定构建失败的根本原因。用户可以设置 --build_event_publish_all_actions 标志以包含所有 ActionExecuted 事件。

BuildFinished

命令完成后，系统会发送单个 BuildFinished 事件，其中包含命令的退出代码。此事件提供权威的成功/失败信息。

BuildMetadata

包含 --build_metadata 标志的已解析内容。此事件旨在通过处理外部数据（例如标识符）来支持 Bazel 与其他工具的集成。

BuildMetrics

系统会在每个命令结束时发送单个 BuildMetrics 事件，其中包含用于量化构建工具在命令执行期间的行为的计数器/量表。这些指标表示实际完成的工作，不会计入重复使用的缓存工作。

请注意，如果在命令执行期间没有 Java 垃圾回收，系统可能不会填充 memory_metrics。用户可以设置 --memory_profile=/dev/null 选项，这会强制垃圾回收器在命令结束时运行，以填充 memory_metrics。

{
  "id": {
    "buildMetrics": {}
  },
  "buildMetrics": {
    "actionSummary": {
      "actionsExecuted": "1"
    },
    "memoryMetrics": {},
    "targetMetrics": {
      "targetsLoaded": "9",
      "targetsConfigured": "19"
    },
    "packageMetrics": {
      "packagesLoaded": "5"
    },
    "timingMetrics": {
      "cpuTimeInMs": "1590",
      "wallTimeInMs": "359"
    }
  }
}

BuildStarted

BEP 流中的第一个事件 BuildStarted 包括在任何有意义的工作开始之前描述命令的元数据。

BuildToolLogs

系统会在命令结束时发送单个 BuildToolLogs 事件，包括构建工具生成的文件的 URI，这些 URI 可能有助于理解或调试构建工具行为。部分信息可能会以内嵌方式包含在内。

{
  "id": {
    "buildToolLogs": {}
  },
  "lastMessage": true,
  "buildToolLogs": {
    "log": [
      {
        "name": "elapsed time",
        "contents": "MC4xMjEwMDA="
      },
      {
        "name": "process stats",
        "contents": "MSBwcm9jZXNzOiAxIGludGVybmFsLg=="
      },
      {
        "name": "command.profile.gz",
        "uri": "file:///tmp/.cache/bazel/_bazel_foo/cde87985ad0bfef34eacae575224b8d1/command.profile.gz"
      }
    ]
  }
}

CommandLine

BEP 包含多个 CommandLine 事件，其中包含所有命令行参数（包括选项和未解释的参数）的表示法。每个 CommandLine 事件的 StructuredCommandLineId 中都有一个标签，用于指示其传达的表示形式；BEP 中会显示以下三种事件：

"original"：将命令行重建为 Bazel 从 Bazel 客户端接收的命令行，而不包含来自 .rc 文件的启动选项。
"canonical"：已展开 .rc 文件并应用了调用政策的有效命令行。
"tool"：通过 --experimental_tool_command_line 选项填充。这有助于传达通过 BEP 封装 Bazel 的工具的命令行。这可以是直接使用且经过 base64 编码的 CommandLine 二进制协议缓冲区消息，也可以是已解析但未解译的字符串（因为该工具的选项可能与 Bazel 的选项不同）。

配置

对于 build 的顶级目标中使用的每个 configuration，系统都会发送 Configuration 事件。至少有一个配置事件始终存在。id 由 TargetConfigured 和 TargetComplete 事件 ID 重复使用，在多配置 build 中消除这些事件的歧义是必要的。

{
  "id": {
    "configuration": {
      "id": "a5d130b0966b4a9ca2d32725aa5baf40e215bcfc4d5cdcdc60f5cc5b4918903b"
    }
  },
  "configuration": {
    "mnemonic": "k8-fastbuild",
    "platformName": "k8",
    "cpu": "k8",
    "makeVariable": {
      "COMPILATION_MODE": "fastbuild",
      "TARGET_CPU": "k8",
      "GENDIR": "bazel-out/k8-fastbuild/bin",
      "BINDIR": "bazel-out/k8-fastbuild/bin"
    }
  }
}

ConvenienceSymlinksIdentified

实验性 - 如果设置了 --experimental_convenience_symlinks_bep_event 选项，则 build 命令会生成单个 ConvenienceSymlinksIdentified 事件，以指明应如何管理工作区中的符号链接。这使您可以构建用于远程调用 Bazel 的工具，然后安排本地工作区，就像 Bazel 已在本地运行一样。

{
  "id": {
    "convenienceSymlinksIdentified":{}
  },
  "convenienceSymlinksIdentified": {
    "convenienceSymlinks": [
      {
        "path": "bazel-bin",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out/k8-fastbuild/bin"
      },
      {
        "path": "bazel-genfiles",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out/k8-fastbuild/genfiles"
      },
      {
        "path": "bazel-out",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out"
      }
    ]
  }
}

提取

表示提取操作是命令执行过程的一部分。与其他事件不同，如果重复使用缓存的提取结果，此事件不会出现在 BEP 流中。

NamedSetOfFiles

NamedSetOfFiles 事件报告一个结构，该结构与命令评估期间生成的文件的 depset 匹配。传递性包含的废弃设置由 NamedSetOfFilesId 进行标识。

如需详细了解如何解读数据流的 NamedSetOfFiles 事件，请参阅 BEP 示例页面。

OptionsParsed

单个 OptionsParsed 事件会列出应用于命令的所有选项，将启动选项与命令选项分开。它还包含 InvocationPolicy（如果有）。

{
  "id": {
    "optionsParsed": {}
  },
  "optionsParsed": {
    "startupOptions": [
      "--max_idle_secs=10800",
      "--noshutdown_on_low_sys_mem",
      "--connect_timeout_secs=30",
      "--output_user_root=/tmp/.cache/bazel/_bazel_foo",
      "--output_base=/tmp/.cache/bazel/_bazel_foo/a61fd0fbee3f9d6c1e30d54b68655d35",
      "--deep_execroot",
      "--expand_configs_in_place",
      "--idle_server_tasks",
      "--write_command_log",
      "--nowatchfs",
      "--nofatal_event_bus_exceptions",
      "--nowindows_enable_symlinks",
      "--noclient_debug",
    ],
    "cmdLine": [
      "--enable_platform_specific_config",
      "--build_event_json_file=/tmp/bep.json"
    ],
    "explicitCmdLine": [
      "--build_event_json_file=/tmp/bep.json"
    ],
    "invocationPolicy": {}
  }
}

PatternExpanded

PatternExpanded 事件表示与命令行中提供的模式匹配的所有目标的集合。如果命令成功，则一个事件会在 PatternExpandedId 中包含所有模式，并在 PatternExpanded 事件的子项中包含所有目标。如果该模式展开为任何 test_suite，则表示 test_suite 包含的一组测试目标。对于每个无法解析的格式，BEP 会额外添加一个 Aborted 事件，用 PatternExpandedId 标识该格式。

{
  "id": {
    "pattern": {
      "pattern":["//base:all"]
    }
  },
  "children": [
    {"targetConfigured":{"label":"//base:foo"}},
    {"targetConfigured":{"label":"//base:foobar"}}
  ],
  "expanded": {
    "testSuiteExpansions": {
      "suiteLabel": "//base:suite",
      "testLabels": "//base:foo_test"
    }
  }
}

进度

进度事件包含 Bazel 在命令执行期间生成的标准输出和标准错误。系统也会根据需要自动生成这些事件，以通告尚未由逻辑“父”事件（尤其是 NamedSetOfFiles）公布的事件。

TargetComplete

对于完成执行阶段的每个 (target, configuration, aspect) 组合，BEP 中都会包含一个 TargetComplete 事件。该事件包含目标的成功/失败情况以及目标所请求的输出组。

{
  "id": {
    "targetCompleted": {
      "label": "//examples/py:bep",
      "configuration": {
        "id": "a5d130b0966b4a9ca2d32725aa5baf40e215bcfc4d5cdcdc60f5cc5b4918903b"
      }
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [
      {
        "name": "default",
        "fileSets": [
          {
            "id": "0"
          }
        ]
      }
    ]
  }
}

TargetConfigured

对于完成分析阶段的每个目标，BEP 中都会包含一个 TargetConfigured 事件。这是目标的“规则种类”属性的权威来源。应用于目标的配置出现在事件公布的子事件中。

例如，使用 --experimental_multi_cpu 选项进行构建时，系统可能会为具有两种配置的单个目标生成以下 TargetConfigured 事件：

{
  "id": {
    "targetConfigured": {
      "label": "//starlark_configurations/multi_arch_binary:foo"
    }
  },
  "children": [
    {
      "targetCompleted": {
        "label": "//starlark_configurations/multi_arch_binary:foo",
        "configuration": {
          "id": "c62b30c8ab7b9fc51a05848af9276529842a11a7655c71327ade26d7c894c818"
        }
      }
    },
    {
      "targetCompleted": {
        "label": "//starlark_configurations/multi_arch_binary:foo",
        "configuration": {
          "id": "eae0379b65abce68d54e0924c0ebcbf3d3df26c6e84ef7b2be51e8dc5b513c99"
        }
      }
    }
  ],
  "configured": {
    "targetKind": "foo_binary rule"
  }
}

TargetSummary

对于执行的每个 (target, configuration) 对，都会包含一个 TargetSummary 事件以及一个汇总成功结果，该结果包含所配置目标的执行情况以及应用于该配置目标的所有方面。

TestResult

如果请求测试，则每次测试尝试、对每个测试进行分片和运行都会发送 TestResult 事件。这样，BEP 使用者可以精确地确定哪些测试操作未通过其测试，并识别每个测试操作的测试输出（例如日志、test.xml 文件）。

TestSummary

如果请求测试，则系统会为每个测试 (target, configuration) 发送一个 TestSummary 事件，其中包含解读测试结果所需的信息。报告中纳入了每次测试的尝试次数、分片数和运行次数，目的是让 BEP 使用方能够在这些维度上区分工件。系统在生成汇总的 TestStatus 以将 FLAKY 测试与 FAILED 测试区分开来时，会考虑每次测试的尝试次数和运行次数。

UnstructuredCommandLine

与“CommandLine”不同，此事件在展开所有 .bazelrc 文件并考虑 --config 标志后，携带字符串形式的未解析命令行标志。CommandLine

UnstructuredCommandLine 事件可用于精确重现指定的命令执行。

WorkspaceConfig

单个 WorkspaceConfig 事件包含有关工作区的配置信息，例如执行根。

WorkspaceStatus

单个 WorkspaceStatus 事件包含工作区状态命令的结果。