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

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

本页面介绍了如何在远程执行的上下文中检查缓存命中率以及如何调查缓存未命中。

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

检查缓存命中率

在 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，然后运行构建/测试命令。

排查缓存命中问题

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

确保重新运行相同的构建/测试命令会产生缓存命中

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

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

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

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

  5. 差异的可能来源是构建中的某些非密封内容，导致操作在两次运行中收到不同的操作键。如需查找这些操作，请执行以下操作：

    a. 重新运行有问题的构建或测试，以获取执行日志：

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

    b. 比较执行日志在 两次运行之间。确保两个日志文件中的操作相同。 差异提供了有关 运行之间发生的更改的线索。更新构建以消除这些差异。

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

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

  6. 检查执行日志中的所有操作是否都将 cacheable 设置为 true。如果执行日志中没有显示给定操作的 cacheable，则表示相应规则的定义可能在 BUILD 文件中包含 no-cache 标记。查看执行日志中的 mnemonic 和 target_label 字段，以帮助确定操作的来源。

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

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

    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 文件。

确保跨机器缓存

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

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

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

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

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

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

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

比较执行日志

执行日志包含构建期间执行的操作的记录。 每条记录都描述了操作的输入（不仅包括文件，还包括命令行实参、环境变量等）和输出。因此，检查日志可以揭示操作被重新执行的原因。

执行日志可以采用以下三种格式之一生成：紧凑型 (--execution_log_compact_file)、二进制 (--execution_log_binary_file) 或 JSON (--execution_log_json_file)。建议使用紧凑型格式，因为它生成的文件小得多，运行时开销也很小。以下说明适用于任何格式。您还可以使用 //src/tools/execlog:converter 工具在它们之间进行转换。

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

  1. 从每个构建中获取执行日志，并将它们存储为 /tmp/exec1.log 和 /tmp/exec2.log。

  2. 下载 Bazel 源代码并构建 //src/tools/execlog:parser 工具：

    git clone https://github.com/bazelbuild/bazel.git cd bazel bazel build //src/tools/execlog:parser

  3. 使用 //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。