Build Event Protocol (BEP) cho phép các chương trình bên thứ ba nắm được thông tin chi tiết về một lệnh gọi Bazel. Ví dụ: bạn có thể sử dụng BEP để thu thập thông tin cho một trình bổ trợ IDE hoặc một trang tổng quan hiển thị kết quả bản dựng.
Giao thức này là một tập hợp các thông báo vùng đệm giao thức với một số ngữ nghĩa được xác định trên đó. Trong đó có thông tin về kết quả kiểm thử và bản dựng, tiến trình xây dựng, cấu hình bản dựng và nhiều thông tin khác. BEP được thiết kế để sử dụng theo phương thức lập trình và giúp việc phân tích cú pháp đầu ra dòng lệnh của Bazel trở thành quá khứ.
Build Event Protocol (Giao thức sự kiện về bản dựng) thể hiện thông tin về một bản dựng dưới dạng các sự kiện. Sự kiện bản dựng là một thông báo bộ đệm giao thức bao gồm một giá trị nhận dạng sự kiện bản dựng, một tập hợp các giá trị nhận dạng sự kiện con và một tải trọng.
Build Event Identifier (Mã nhận dạng sự kiện bản dựng): Tuỳ thuộc vào loại sự kiện bản dựng, mã này có thể là một chuỗi không rõ ràng hoặc thông tin có cấu trúc cho biết thêm về sự kiện bản dựng. Giá trị nhận dạng sự kiện bản dựng là duy nhất trong một bản dựng.
Phần tử con: Một sự kiện về bản dựng có thể thông báo các sự kiện khác về bản dựng bằng cách đưa mã nhận dạng sự kiện về bản dựng của các sự kiện đó vào trường phần tử con. Ví dụ: sự kiện
PatternExpandedbuild sẽ thông báo các mục tiêu mà sự kiện này mở rộng thành các thành phần con. Giao thức này đảm bảo rằng tất cả các sự kiện, ngoại trừ sự kiện đầu tiên, đều được thông báo bởi một sự kiện trước đó.Tải trọng: Tải trọng chứa thông tin có cấu trúc về một sự kiện bản dựng, được mã hoá dưới dạng thông báo vùng đệm giao thức dành riêng cho sự kiện đó. Xin lưu ý rằng tải trọng có thể không phải là loại dự kiến, nhưng có thể là một thông báo
Abortednếu quá trình tạo bị huỷ sớm.
Tạo biểu đồ sự kiện
Tất cả các sự kiện bản dựng tạo thành một biểu đồ có hướng không chu kỳ thông qua mối quan hệ mẹ và con. Mọi sự kiện bản dựng (ngoại trừ sự kiện bản dựng ban đầu) đều có một hoặc nhiều sự kiện mẹ. Xin lưu ý rằng không phải tất cả các sự kiện gốc của một sự kiện con đều phải được đăng trước sự kiện con đó. Khi quá trình tạo hoàn tất (thành công hoặc không thành công), tất cả các sự kiện được thông báo sẽ được đăng. Trong trường hợp Bazel gặp sự cố hoặc quá trình truyền tải mạng không thành công, một số sự kiện bản dựng đã thông báo có thể không bao giờ được đăng.
Cấu trúc của biểu đồ sự kiện phản ánh vòng đời của một lệnh. Mọi biểu đồ BEP đều có hình dạng đặc trưng sau:
- Sự kiện gốc luôn là một sự kiện
BuildStarted. Tất cả các sự kiện khác đều là sự kiện con của sự kiện này. - Các thành phần con ngay lập tức của sự kiện BuildStarted chứa siêu dữ liệu về lệnh.
- Các sự kiện chứa dữ liệu do lệnh tạo ra, chẳng hạn như các tệp được tạo và kết quả kiểm thử, sẽ xuất hiện trước sự kiện
BuildFinished. - Sự kiện
BuildFinishedcó thể được theo dõi bằng các sự kiện chứa thông tin tóm tắt về bản dựng (ví dụ: dữ liệu chỉ số hoặc dữ liệu lập hồ sơ).
Sử dụng Giao thức sự kiện bản dựng
Tiêu thụ ở định dạng nhị phân
Cách sử dụng BEP ở định dạng nhị phân:
Hãy để Bazel tuần tự hoá các thông báo vùng đệm giao thức vào một tệp bằng cách chỉ định lựa chọn
--build_event_binary_file=/path/to/file. Tệp này sẽ chứa các thông báo bộ đệm giao thức được chuyển đổi tuần tự, trong đó mỗi thông báo được phân tách theo độ dài. Mỗi thông báo đều có tiền tố là độ dài được mã hoá dưới dạng một số nguyên có độ dài thay đổi. Bạn có thể đọc định dạng này bằng phương thứcparseDelimitedFrom(InputStream)của thư viện vùng đệm giao thức.Sau đó, hãy viết một chương trình trích xuất thông tin liên quan từ thông báo bộ đệm giao thức được chuyển đổi tuần tự.
Sử dụng ở định dạng văn bản hoặc JSON
Các cờ dòng lệnh Bazel sau đây sẽ xuất BEP ở định dạng mà con người đọc được, chẳng hạn như văn bản và JSON:
--build_event_text_file
--build_event_json_file
Xây dựng dịch vụ sự kiện
Giao thức Build Event Service là một dịch vụ gRPC chung để xuất bản các sự kiện bản dựng. Giao thức Build Event Service (Dịch vụ tạo sự kiện) độc lập với BEP và coi các sự kiện BEP là các byte không rõ ràng.
Bazel đi kèm với một chế độ triển khai ứng dụng gRPC của giao thức Build Event Service (Dịch vụ sự kiện bản dựng) để xuất bản các sự kiện Build Event Protocol (Giao thức sự kiện bản dựng). Bạn có thể chỉ định điểm cuối để gửi các sự kiện đến bằng cách sử dụng cờ --bes_backend=HOST:PORT. Nếu phần phụ trợ của bạn sử dụng gRPC, bạn phải thêm tiền tố vào địa chỉ bằng lược đồ thích hợp: grpc:// cho gRPC văn bản thuần tuý và grpcs:// cho gRPC có bật TLS.
Tạo cờ Dịch vụ sự kiện
Bazel có một số cờ liên quan đến giao thức Build Event Service, bao gồm:
--bes_backend--[no]bes_lifecycle_events--bes_results_url--bes_timeout--bes_instance_name
Để biết nội dung mô tả về từng cờ này, hãy xem Tài liệu tham khảo về dòng lệnh.
Xác thực và bảo mật
Việc triển khai Dịch vụ sự kiện bản dựng của Bazel cũng hỗ trợ xác thực và TLS. Bạn có thể kiểm soát các chế độ cài đặt này bằng cách sử dụng các cờ bên dưới. Xin lưu ý rằng các cờ này cũng được dùng cho tính năng Thực thi từ xa của Bazel. Điều này ngụ ý rằng Dịch vụ Sự kiện Xây dựng và Điểm cuối Thực thi Từ xa cần dùng chung cơ sở hạ tầng xác thực và TLS.
--[no]google_default_credentials--google_credentials--google_auth_scopes--tls_certificate--[no]tls_enabled
Để biết nội dung mô tả về từng cờ này, hãy xem Tài liệu tham khảo về dòng lệnh.
Tạo Dịch vụ sự kiện và bộ nhớ đệm từ xa
BEP thường chứa nhiều thông tin tham chiếu đến các tệp nhật ký (test.log, test.xml, v.v.) được lưu trữ trên máy mà Bazel đang chạy. Thông thường, một máy chủ BES từ xa không thể truy cập vào các tệp này vì chúng nằm trên các máy khác nhau. Một cách để giải quyết vấn đề này là sử dụng Bazel với tính năng lưu vào bộ nhớ đệm từ xa. Bazel sẽ tải tất cả các tệp đầu ra lên bộ nhớ đệm từ xa (bao gồm cả các tệp được tham chiếu trong BEP) và sau đó, máy chủ BES có thể tìm nạp các tệp được tham chiếu từ bộ nhớ đệm.
Hãy xem vấn đề 3689 trên GitHub để biết thêm thông tin chi tiết.