원격 실행을 위한 원격 캐시 적중 디버깅

이 페이지에서는 캐시 적중률을 확인하는 방법과 원격 실행 컨텍스트에서 캐시 부적중을 조사하는 방법을 설명합니다.

이 페이지에서는 원격 실행을 성공적으로 활용하는 빌드 또는 테스트가 있으며 원격 캐시를 효과적으로 활용하고 있는지 확인해야 한다고 가정합니다.

캐시 적중률 확인

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를 실행한 다음 빌드/테스트 명령어를 실행합니다.

캐시 적중 문제 해결

캐시 적중률이 기대에 미치지 못하는 경우 다음 단계를 따르세요.

동일한 빌드/테스트 명령어를 다시 실행하면 캐시 적중이 발생하는지 확인합니다.

캐시를 채울 것으로 예상되는 빌드 또는 테스트를 실행합니다. 새 빌드가 특정 스택에서 처음 실행될 때는 원격 캐시 적중이 없을 것으로 예상됩니다. 원격 실행의 일부로 작업 결과가 캐시에 저장되고 후속 실행에서 이 결과가 선택됩니다.
bazel clean을 실행합니다. 이 명령어는 로컬 캐시를 정리하므로, 로컬 캐시 적중으로 결과가 마스킹되지 않고 원격 캐시 적중을 조사할 수 있습니다.
조사 중인 빌드와 테스트를 동일한 머신에서 다시 실행합니다.
INFO 줄에서 캐시 적중률을 확인합니다. remote cache hit 및 internal를 제외한 프로세스가 보이지 않으면 캐시가 올바르게 채워지고 액세스되고 있는 것입니다. 그런 경우에는 다음 섹션으로 건너뛰세요.
불일치의 가능한 원인은 빌드에 밀폐되지 않은 문제로 두 번의 실행에 걸쳐 작업이 서로 다른 작업 키를 받게 되는 것입니다. 이러한 작업을 찾으려면 다음 단계를 따르세요.

a. 문제의 빌드 또는 테스트를 다시 실행하여 실행 로그를 얻습니다.
```
  bazel clean
  bazel --optional-flags build //your:target --execution_log_binary_file=/tmp/exec1.log
```
b. 두 실행 간의 실행 로그를 비교합니다. 두 로그 파일에서 작업이 동일한지 확인합니다. 불일치는 실행 사이에 발생한 변경사항에 대한 단서를 제공합니다. 빌드를 업데이트하여 이러한 불일치를 없앱니다.

캐싱 문제를 해결할 수 있고 이제 반복 실행에서 모든 캐시 적중이 발생하는 경우 다음 섹션으로 건너뜁니다.

작업 ID가 동일하지만 캐시 적중이 없으면 구성의 무언가가 캐싱을 차단하고 있는 것입니다. 이 섹션을 계속 진행하여 일반적인 문제를 확인합니다.
실행 로그의 모든 작업에 cacheable가 true로 설정되어 있는지 확인합니다. 제공 작업의 실행 로그에 cacheable이 표시되지 않으면 해당 규칙의 BUILD 파일의 정의에 no-cache 태그가 있을 수 있습니다. 실행 로그에서 mnemonic 및 target_label 필드를 확인하면 작업이 어디에서 발생하는지 확인하는 데 도움이 됩니다.
작업이 동일하고 cacheable이지만 캐시 적중이 없는 경우 명령줄에 빌드의 캐시 조회를 사용 중지하는 --noremote_accept_cached가 포함되어 있을 수 있습니다.

실제 명령줄을 파악하기가 어렵다면 다음과 같이 빌드 이벤트 프로토콜의 표준 명령줄을 사용하세요.

a. 텍스트의 로그 버전을 얻으려면 Bazel 명령어에 --build_event_text_file=/tmp/bep.txt를 추가하세요.

b. 텍스트 버전의 로그를 열고 command_line_label: "canonical"를 사용하여 structured_command_line 메시지를 검색합니다. 펼친 후 모든 옵션이 표시됩니다.

c. remote_accept_cached를 검색하여 false로 설정되어 있는지 확인합니다.

d. remote_accept_cached이 false이면 명령줄 또는 bazelrc 파일에서 false로 설정할 위치를 결정합니다.

머신 간 캐싱 보장

동일한 머신에서 캐시 적중이 예상대로 발생하면 다른 머신에서 동일한 빌드/테스트를 실행합니다. 여러 머신에서 캐싱이 발생하지 않는다고 생각되면 다음을 수행합니다.

기존 캐시에 영향을 주지 않도록 빌드를 약간 수정합니다.

첫 번째 머신에서 빌드를 실행합니다.

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

두 번째 머신에서 빌드를 실행하고 1단계의 수정사항이 포함되는지 확인합니다.
```
 bazel clean
 bazel ... build ... --execution_log_binary_file=/tmp/exec2.log
```
두 실행의 실행 로그를 비교합니다. 로그가 동일하지 않으면 빌드 구성에 불일치가 있는지, 그리고 두 빌드 중 하나로 누출되는 호스트 환경의 속성이 있는지 조사합니다.

실행 로그 비교

실행 로그에는 빌드 중에 실행된 모든 작업 기록이 포함됩니다. 각 작업에는 작업 키의 모든 정보가 포함된 SpawnExec 요소가 있습니다. 따라서 로그가 동일하면 작업 캐시 키도 마찬가지입니다.

캐시 적중을 예상대로 공유하지 않는 두 빌드의 로그를 비교하려면 다음 단계를 따르세요.

각 빌드에서 실행 로그를 가져와서 /tmp/exec1.log 및 /tmp/exec2.log로 저장합니다.
Bazel 소스 코드를 다운로드하고 아래 명령어를 사용하여 Bazel 폴더로 이동합니다. execlog 파서로 실행 로그를 파싱하려면 소스 코드가 필요합니다.
```
git clone https://github.com/bazelbuild/bazel.git
cd bazel
```
실행 로그 파서를 사용하여 로그를 텍스트로 변환합니다. 다음 호출은 쉽게 비교할 수 있도록 첫 번째 로그의 작업 순서와 일치하도록 두 번째 로그의 작업을 정렬합니다.
```
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
```
/tmp/exec1.log.txt 및 /tmp/exec2.log.txt와 다른 선호하는 텍스트를 사용하세요.