Giao thức tạo sự kiện (BEP) cho phép các chương trình bên thứ ba thu thập thông tin chi tiết về lệnh gọi Bazel. Ví dụ: bạn có thể sử dụng BEP để thu thập thông tin cho trình bổ trợ IDE hoặc 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 bên trên. Bảng này bao gồm thông tin về kết quả xây dựng và kiểm thử, 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 dùng theo phương thức lập trình và khiến việc phân tích cú pháp dòng lệnh của Bazel trở thành lỗi thời.
Giao thức sự kiện bản dựng biểu thị thông tin về một bản dựng dưới dạng sự kiện. Sự kiện bản dựng là một thông báo vùng đệm giao thức bao gồm 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à tải trọng.
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, đó có thể là một chuỗi mờ hoặc thông tin có cấu trúc cho biết thêm thông tin 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.
Con: Một sự kiện bản dựng có thể thông báo các sự kiện bản dựng khác, bằng cách đưa giá trị nhận dạng sự kiện bản dựng vào trường con. Ví dụ: sự kiện bản dựng
PatternExpandedsẽ thông báo các mục tiêu mà sự kiện này mở rộng dưới dạng thành phần con. Giao thức đảm bảo rằng tất cả sự kiện (ngoại trừ sự kiện đầu tiên) đều được sự kiện trước công bố.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 đó. 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à thông báo
Abortednếu bản dựng 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 đồ thị tuần hoàn có định hướng thông qua mối quan hệ mẹ và con. Mỗi sự kiện tạo 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 một số sự kiện mẹ của sự kiện con không nhất thiết phải được đăng trước sự kiện đó. Khi quá trình tạo bản dựng hoàn tất (thành công hoặc không thành công), tất cả các sự kiện đã thông báo sẽ được đăng. Trong trường hợp xảy ra sự cố Bazel hoặc lỗi truyền tải mạ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à sự kiện
BuildStarted. Tất cả các sự kiện khác đều là thành phần con của nó. - Phần tử con tức thì 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. - Theo sau sự kiện
BuildFinished, có thể là 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
Sử dụng ở định dạng nhị phân
Cách sử dụng BEP ở định dạng nhị phân:
Yêu cầu Bazel chuyển đổi tuần tự các thông báo vùng đệm giao thức thành một tệp bằng cách chỉ định tuỳ chọn
--build_event_binary_file=/path/to/file. Tệp này sẽ chứa các thông báo vùng đệm giao thức tuần tự, trong đó mỗi thông báo được phân tách độ dài. Mỗi thông báo có tiền tố là độ dài được mã hoá dưới dạng 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 vùng đệm giao thứ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 ở các định dạng con người có thể đọ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 dịch vụ sự kiện xây dựng là một dịch vụ gRPC chung để phát hành sự kiện bản dựng. Giao thức Dịch vụ sự kiện bản dựng độc lập với BEP và coi các sự kiện BEP là các byte mờ.
Bazel xuất bản triển khai ứng dụng gRPC của giao thức Dịch vụ sự kiện bản dựng để phát hành các sự kiện Giao thức sự kiện bản dựng. Người dùng có thể chỉ định điểm cuối để gửi các sự kiện để 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ố địa chỉ bằng lược đồ thích hợp: grpc:// đối với gRPC dưới dạng văn bản thuần tuý và grpcs:// đối với gRPC có bật TLS.
Xây dựng cờ Dịch vụ sự kiện
Bazel có một số cờ liên quan đến giao thức Build Event Service (Dịch vụ sự kiện bản dựng), bao gồm:
--bes_backend--[no]bes_best_effort--[no]bes_lifecycle_events--bes_results_url--bes_timeout--bes_instance_name
Để biết nội dung mô tả của từng cờ này, hãy xem phần Tham chiếu 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ợ tính năng xác thực và TLS (Bảo mật tầng truyền tải). Bạn có thể kiểm soát các chế độ cài đặt này bằng các cờ dưới đây. Xin lưu ý rằng các cờ này cũng dùng cho quá trình Thực thi từ xa của Bazel. Điều này có nghĩa là Dịch vụ sự kiện bản dựng và Điểm cuối thực thi từ xa cần có cùng một cơ sở hạ tầng TLS (Bảo mật tầng truyền tải) và xác thực.
--[no]google_default_credentials--google_credentials--google_auth_scopes--tls_certificate--[no]tls_enabled
Để biết nội dung mô tả của từng cờ này, hãy xem phần Tham chiếu dòng lệnh.
Xây dựng dịch vụ sự kiện và lưu vào bộ nhớ đệm từ xa
BEP thường chứa nhiều tệp tham chiếu đến tệp nhật ký (test.log, test.xml, v.v.) được lưu trữ trên máy mà Bazel đang chạy. Máy chủ BES từ xa thường 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à máy chủ BES sau đó có thể tìm nạp các tệp được tham chiếu từ bộ nhớ đệm.
Hãy xem Vấn đề 3689 của GitHub để biết thêm thông tin chi tiết.