调试远程缓存命中以进行远程执行

本页介绍了如何检查缓存命中率，以及如何在远程执行环境中调查缓存未命中问题。

本页面假定您有一个成功利用远程执行的 build 和/或测试，并且您希望确保有效利用远程缓存。

检查您的缓存命中率

在 Bazel 运行的标准输出中，查看列出进程的 INFO 行，这些进程大致对应于 Bazel 操作。该行详细说明了操作的运行位置。查找 remote 标签（表示远程执行的操作）、linux-sandbox（表示在本地沙盒中执行的操作），以及其他执行策略的其他值。结果来自远程缓存的操作会显示为 remote cache hit。

例如：

INFO: 11 processes: 6 remote cache hit, 3 internal, 2 remote.

在此示例中，有 6 次远程缓存命中，有 2 项操作没有缓存命中并远程执行。可以忽略 3 个内部部分。 这通常是一些微小的内部操作，例如创建符号链接。此摘要不包含本地缓存命中。如果您得到的进程数为 0（或低于预期），请依次运行 bazel clean 和 build/test 命令。

缓存命中问题排查

如果您没有获得预期的缓存命中率，请执行以下操作：

确保重新运行同一 build/test 命令会产生缓存命中

  1. 运行您希望填充缓存的构建和/或测试。首次在特定堆栈上运行新 build 时，您可能不会获得任何远程缓存命中。在远程执行过程中，操作结果会存储在缓存中，后续运行应该会提取它们。

  2. 运行 bazel clean。此命令会清除您的本地缓存，这样一来，您便可以在没有本地缓存命中的情况下调查远程缓存命中，而不会被本地缓存命中结果所掩盖。

  3. 再次运行要调查的 build 和测试（在同一台机器上）。

  4. 检查 INFO 行中的缓存命中率。如果您除了 remote cache hit 和 internal 之外没有看到任何进程，则表示您的缓存正在正确填充和访问。在这种情况下，请跳到下一部分。

  5. 造成差异的一个可能原因是 build 中存在非密封项，导致操作在两次运行中收到不同的操作键。如需查找这些操作，请执行以下操作：

    a. 重新运行相关的构建或测试以获取执行日志：

      bazel clean
  bazel --optional-flags build //your:target --execution_log_binary_file=/tmp/exec1.log

    b. 比较两次运行的执行日志。确保两个日志文件中的操作完全相同。 差异可为您提供运行期间发生的更改的线索。请更新您的 build 以消除这些差异。

    如果您能够解决缓存问题，并且现在重复运行会生成所有缓存命中，请跳到下一部分。

    如果您的操作 ID 相同，但没有缓存命中，则表示您的配置中的某些因素阻止了缓存。请继续阅读本部分，检查是否存在常见问题。

    如果您不需要比较执行日志，则可以改用简单易懂的 --execution_log_json_file 标志。由于它包含执行时间且不保证有序，因此无法用于稳定的差异化。

  6. 检查执行日志中的所有操作是否均将 cacheable 设置为 true。如果某个操作的执行日志中未显示 cacheable，则表示相应规则的 BUILD 文件定义中可能包含 no-cache 标记。查看执行日志中人类可读的 progress_message 字段，以帮助确定操作的来源。

  7. 如果操作完全相同且 cacheable，但没有缓存命中，则可能是因为您的命令行包含 --noremote_accept_cached，这会停用对 build 的缓存查找。

    如果难以确定实际命令行，请使用 Build Event Protocol 中的规范命令行，如下所示：

    a. 将 --build_event_text_file=/tmp/bep.txt 添加到 Bazel 命令中，以获取日志的文本版本。

    b. 打开日志的文本版本，并搜索包含 command_line_label: "canonical" 的 structured_command_line 消息。展开后，系统会列出所有选项。

    c. 搜索 remote_accept_cached 并检查它是否设置为 false。

    d. 如果 remote_accept_cached 为 false，请确定它是在哪里被设置为 false：命令行还是 bazelrc 文件中。

确保跨机器缓存

在同一台机器上按预期发生缓存命中后，请在其他机器上运行相同的 build/测试。如果您怀疑缓存未跨机器进行，请执行以下操作：

  1. 对 build 进行少量修改，以避免命中现有缓存。

  2. 在第一台机器上运行 build：

     bazel clean
 bazel ... build ... --execution_log_binary_file=/tmp/exec1.log

  3. 在第二台机器上运行 build，确保包含第 1 步中的修改：

     bazel clean
 bazel ... build ... --execution_log_binary_file=/tmp/exec2.log

  4. 比较这两次运行的执行日志。如果日志不相同，请检查 build 配置是否存在差异，以及是否有来自主机环境的属性泄露到其中任一 build 中。

比较执行日志

执行日志包含构建期间执行的所有操作的记录。对于每个操作，都有一个 SpawnExec 元素，其中包含操作键中的所有信息。因此，如果日志相同，则操作缓存键也相同。

如需比较两个构建的日志，并确认它们未按预期共享缓存命中，请执行以下操作：

  1. 从每个 build 获取执行日志，并将其存储为 /tmp/exec1.log 和 /tmp/exec2.log。

  2. 下载 Bazel 源代码，然后使用以下命令导航到 Bazel 文件夹。您需要源代码才能使用 execlog 解析器解析执行日志。

    git clone https://github.com/bazelbuild/bazel.git
cd bazel

  3. 使用执行日志解析器将日志转换为文本。以下调用还会对第二个日志中的操作进行排序，使其与第一个日志中的操作顺序相匹配，以便于比较。

    bazel build src/tools/execlog:parser
bazel-bin/src/tools/execlog/parser \
  --log_path=/tmp/exec1.log \
  --log_path=/tmp/exec2.log \
  --output_path=/tmp/exec1.log.txt \
  --output_path=/tmp/exec2.log.txt

  4. 使用您喜爱的文本来区分 /tmp/exec1.log.txt 和 /tmp/exec2.log.txt。