ローカル実行のためのリモート キャッシュ ヒットのデバッグ

問題を報告 ソースを表示

このページでは、ローカル実行のコンテキストでキャッシュミスを調査する方法について説明します。

このページでは、ローカルで正常にビルドされ、リモート キャッシュを使用するよう設定されているビルドやテストがあり、リモート キャッシュが効果的に使用されていることを前提としています。

キャッシュ ヒット率を確認する方法と、2 つの Bazel 呼び出し間で実行ログを比較する方法のヒントについては、リモート実行のリモート キャッシュ ヒットのデバッグをご覧ください。このガイドの内容はすべて、ローカル実行によるリモート キャッシュにも当てはまります。ただし、ローカル実行にはいくつかの追加の課題があります。

キャッシュ ヒット率の確認

リモート キャッシュ ヒットに成功すると、リモート実行でのキャッシュ ヒット率と同様に、ステータス ラインに表示されます。

Bazel 実行の標準出力に、次のように表示されます。

   INFO: 7 processes: 3 remote cache hit, 4 linux-sandbox.

つまり、試行された 7 つのアクションのうち 3 つはリモート キャッシュ ヒット、4 つのアクションはキャッシュ ヒットせず、linux-sandbox 戦略を使用してローカルで実行されました。ローカル キャッシュのヒットはこの概要には含まれません。プロセスが 0(または想定よりも小さい)の場合は、bazel clean を実行してから、ビルド/テストコマンドを実行します。

キャッシュ ヒットのトラブルシューティング

期待するキャッシュ ヒット率が得られない場合は、次の操作を行います。

リモート エンドポイントとの通信が成功していることを確認する

ビルドがリモート キャッシュと正常に通信できるようにするには、このセクションの手順に沿って操作してください。

  1. 出力に警告がないか確認する

    リモート実行では、リモート エンドポイントとの通信に失敗するとビルドが失敗します。一方、キャッシュ可能なローカルビルドは、キャッシュできなくても失敗しません。Bazel 呼び出しの出力で、次のような警告がないか確認します。

       WARNING: Error reading from the remote cache:
    

    または

       WARNING: Error writing to the remote cache:
    

    このような警告の後に、デバッグに役立つ接続の問題を詳述するエラー メッセージ(エンドポイント名の入力ミス、認証情報の誤った設定など)が続きます。このようなエラーを見つけて対処します。表示されたエラー メッセージに十分な情報がない場合は、--verbose_failures を追加してみてください。

  2. リモート実行でのキャッシュ ヒットのトラブルシューティングの手順に沿って、キャッシュ書き込みの Bazel 呼び出しで同じマシンやマシン間でキャッシュ ヒットを取得できるようにします。

  3. キャッシュ読み取りの Bazel 呼び出しでキャッシュ ヒットを得られることを確認します。

    a. キャッシュ読み取りの Bazel 呼び出しでは、別のコマンドライン設定が使用されるため、リモート キャッシュと通信するために適切に設定されるようにさらに注意してください。--remote_cache フラグが設定され、出力に警告がないことを確認します。

    b. キャッシュ読み取りの Bazel 呼び出しが、キャッシュ書き込みの Bazel 呼び出しと同じターゲットをビルドするようにします。

    c. マシン間でのキャッシュ保存を確認する場合と同じ手順で、キャッシュ書き込みの Bazel 呼び出しからキャッシュ読み取りの Bazel 呼び出しにキャッシュできるようにします。