Gỡ lỗi các lượt truy cập vào bộ nhớ đệm từ xa để thực thi từ xa

Báo cáo vấn đề Xem nguồn Nightly · 7.4 .

Trang này mô tả cách kiểm tra tỷ lệ truy cập vào bộ nhớ đệm và cách điều tra các lần không truy cập được vào bộ nhớ đệm trong bối cảnh thực thi từ xa.

Trang này giả định rằng bạn có một bản dựng và/hoặc kiểm thử sử dụng thành công tính năng thực thi từ xa và bạn muốn đảm bảo rằng bạn đang sử dụng hiệu quả bộ nhớ đệm từ xa.

Kiểm tra tỷ lệ lượt truy cập vào bộ nhớ đệm

Trong kết quả tiêu chuẩn của lần chạy Bazel, hãy xem dòng INFO liệt kê các quy trình tương ứng gần đúng với các hành động của Bazel. Dòng đó nêu chi tiết nơi thực hiện hành động. Tìm nhãn remote, nhãn này cho biết một thao tác được thực thi từ xa, linux-sandbox cho các thao tác được thực thi trong hộp cát cục bộ và các giá trị khác cho các chiến lược thực thi khác. Một hành động có kết quả đến từ bộ nhớ đệm từ xa sẽ hiển thị dưới dạng remote cache hit.

Ví dụ:

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

Trong ví dụ này, có 6 lượt truy cập vào bộ nhớ đệm từ xa và 2 thao tác không có lượt truy cập vào bộ nhớ đệm và được thực thi từ xa. Bạn có thể bỏ qua 3 phần nội bộ. Đây thường là các thao tác nội bộ nhỏ, chẳng hạn như tạo đường liên kết tượng trưng. Số lượt truy cập vào bộ nhớ đệm cục bộ không được đưa vào bản tóm tắt này. Nếu bạn nhận được 0 quy trình (hoặc một con số thấp hơn dự kiến), hãy chạy bazel clean, theo sau là lệnh bản dựng/kiểm thử.

Khắc phục sự cố về số lượt truy cập vào bộ nhớ đệm

Nếu bạn không nhận được tỷ lệ truy cập vào bộ nhớ đệm như mong đợi, hãy làm như sau:

Đảm bảo việc chạy lại cùng một lệnh bản dựng/kiểm thử sẽ tạo ra các lượt truy cập vào bộ nhớ đệm

Chạy(các) bản dựng và/hoặc(các) hoạt động kiểm thử mà bạn muốn đưa vào bộ nhớ đệm. Trong lần đầu tiên chạy một bản dựng mới trên một ngăn xếp cụ thể, bạn có thể không nhận được lượt truy cập vào bộ nhớ đệm từ xa. Trong quá trình thực thi từ xa, kết quả hành động được lưu trữ trong bộ nhớ đệm và lần chạy tiếp theo sẽ nhận được kết quả đó.
Chạy bazel clean. Lệnh này sẽ xoá bộ nhớ đệm cục bộ, cho phép bạn điều tra các lượt truy cập bộ nhớ đệm từ xa mà không khiến kết quả bị che khuất bởi các lượt truy cập bộ nhớ đệm cục bộ.
Chạy (các) bản dựng và kiểm thử mà bạn đang điều tra lại (trên cùng một máy).
Kiểm tra dòng INFO để biết tỷ lệ truy cập vào bộ nhớ đệm. Nếu bạn không thấy quy trình nào ngoại trừ remote cache hit và internal, thì bộ nhớ đệm của bạn đang được điền và truy cập chính xác. Trong trường hợp đó, hãy chuyển sang phần tiếp theo.
Nguyên nhân có thể gây ra sự khác biệt là điều gì đó không liền mạch trong bản dựng, khiến các hành động nhận được các phím hành động khác nhau trong hai lần chạy. Để tìm các thao tác đó, hãy làm như sau:

a. Chạy lại(các) bản dựng hoặc(các) chương trình kiểm thử có liên quan để lấy nhật ký thực thi:
```
  bazel clean
  bazel --optional-flags build //your:target --execution_log_compact_file=/tmp/exec1.log
```
b. So sánh nhật ký thực thi giữa hai lần chạy. Đảm bảo rằng các thao tác trên 2 tệp nhật ký là giống nhau. Sự khác biệt cung cấp gợi ý về những thay đổi đã xảy ra giữa các lần chạy. Hãy cập nhật bản dựng để loại bỏ những điểm chênh lệch đó.

Nếu bạn có thể giải quyết các vấn đề liên quan đến việc lưu vào bộ nhớ đệm và bây giờ, lần chạy lặp lại tạo ra tất cả lượt truy cập bộ nhớ đệm, hãy chuyển đến phần tiếp theo.

Nếu mã nhận dạng hành động của bạn giống hệt nhau nhưng không có lượt truy cập vào bộ nhớ đệm, thì có gì đó trong cấu hình của bạn đang ngăn việc lưu vào bộ nhớ đệm. Tiếp tục với phần này để kiểm tra các vấn đề thường gặp.
Kiểm tra để đảm bảo tất cả hành động trong nhật ký thực thi đã được đặt cacheable thành true. Nếu cacheable không xuất hiện trong nhật ký thực thi cho một thao tác đưa ra, thì có nghĩa là quy tắc tương ứng có thể có thẻ no-cache theo định nghĩa ở tệp BUILD. Hãy xem các trường mnemonic và target_label trong nhật ký thực thi để xác định nguồn gốc của hành động.
Nếu các hành động giống hệt nhau và cacheable nhưng không có lượt truy cập vào bộ nhớ đệm, thì có thể dòng lệnh của bạn bao gồm --noremote_accept_cached sẽ tắt tính năng tra cứu bộ nhớ đệm cho một bản dựng.

Nếu bạn gặp khó khăn trong việc tìm ra dòng lệnh thực tế, hãy sử dụng dòng lệnh chuẩn từ Build Event Protocol (Giao thức sự kiện bản dựng) như sau:

a. Thêm --build_event_text_file=/tmp/bep.txt vào lệnh Bazel để lấy phiên bản văn bản của nhật ký.

b. Mở phiên bản văn bản của nhật ký và tìm thông báo structured_command_line bằng command_line_label: "canonical". Bảng này sẽ liệt kê tất cả lựa chọn sau khi mở rộng.

c. Tìm remote_accept_cached và kiểm tra xem thuộc tính này có được đặt thành false hay không.

d. Nếu remote_accept_cached là false, hãy xác định vị trí đặt thành false: ở dòng lệnh hoặc trong tệp bazelrc.

Đảm bảo lưu vào bộ nhớ đệm trên nhiều máy

Sau khi các lượt truy cập bộ nhớ đệm diễn ra như dự kiến trên cùng một máy, hãy chạy cùng một bản dựng/kiểm thử trên một máy khác. Nếu bạn nghi ngờ việc lưu vào bộ nhớ đệm không diễn ra trên các máy, hãy làm như sau:

Thực hiện một sửa đổi nhỏ đối với bản dựng để tránh truy cập vào bộ nhớ đệm hiện có.

Chạy bản dựng trên máy đầu tiên:

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

Chạy bản dựng trên máy thứ hai, đảm bảo bao gồm nội dung sửa đổi từ bước 1:
```
 bazel clean
 bazel ... build ... --execution_log_compact_file=/tmp/exec2.log
```
So sánh nhật ký thực thi của hai lần chạy. Nếu nhật ký không giống nhau, hãy kiểm tra cấu hình bản dựng để tìm sự khác biệt cũng như các thuộc tính từ môi trường lưu trữ bị rò rỉ vào một trong hai bản dựng.

So sánh nhật ký thực thi

Nhật ký thực thi chứa bản ghi các thao tác được thực thi trong quá trình tạo bản dựng. Mỗi bản ghi mô tả cả dữ liệu đầu vào (không chỉ tệp mà còn cả đối số dòng lệnh, biến môi trường, v.v.) và dữ liệu đầu ra của hành động. Do đó, việc kiểm tra nhật ký có thể cho biết lý do một hành động được thực thi lại.

Bạn có thể tạo nhật ký thực thi ở một trong 3 định dạng: nhỏ gọn (--execution_log_compact_file), nhị phân (--execution_log_binary_file) hoặc JSON (--execution_log_json_file). Bạn nên sử dụng định dạng nhỏ gọn vì định dạng này tạo ra các tệp nhỏ hơn nhiều với mức hao tổn thời gian chạy rất thấp. Các hướng dẫn sau đây áp dụng cho mọi định dạng. Bạn cũng có thể chuyển đổi giữa các loại này bằng công cụ //src/tools/execlog:converter.

Để so sánh nhật ký của hai bản dựng không chia sẻ lượt truy cập vào bộ nhớ đệm như dự kiến, hãy làm như sau:

Nhận nhật ký thực thi của mỗi bản dựng rồi lưu trữ dưới dạng /tmp/exec1.log và /tmp/exec2.log.
Tải mã nguồn Bazel và tạo công cụ //src/tools/execlog:parser:

git bản sao https://github.com/bazelbuild/bazel.git cd bazel bazel build //src/tools/execlog:parser
Sử dụng công cụ //src/tools/execlog:parser để chuyển đổi nhật ký thành định dạng văn bản mà con người có thể đọc được. Ở định dạng này, các hành động trong nhật ký thứ hai được sắp xếp để khớp với thứ tự trong nhật ký đầu tiên, giúp việc so sánh dễ dàng hơn.
```
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
```
Hãy sử dụng văn bản bạn yêu thích để phân biệt /tmp/exec1.log.txt và /tmp/exec2.log.txt.