跳至內容
Chronicle

安裝

發行版本安裝器

標題為「發行版本安裝器」的章節

安裝最新穩定版 Chronicle：

Chronicle 發行版本的二進位檔支援 Linux x86_64 與 aarch64／arm64。儲存庫提供的安裝器會取得 GitHub Release 的設定穩定版本、選擇相符的封存檔、驗證 SHA256SUMS，只有驗證成功後才會安裝。

Terminal window
curl -fsSL https://raw.githubusercontent.com/r05323028/chronicle/main/install.sh | sh

預設安裝到 $HOME/.local/bin。腳本不會修改 shell 設定；如果該目錄不在 PATH 中，腳本會輸出應該執行的 export PATH=... 指令。

確認二進位檔與主機狀態：

Terminal window
chronicle --version
chronicle doctor

doctor 不會修改系統。它會回報平台、架構、cgroup v2、BTF、內嵌擷取程式、掛接狀態、能力、WAL／輸出、協定與 replay policy 的就緒狀態，並提供修正建議。

固定發行版本

標題為「固定發行版本」的章節

版本可以包含開頭的 v，也可以省略：

Terminal window
curl -fsSL https://raw.githubusercontent.com/r05323028/chronicle/main/install.sh \
  | CHRONICLE_VERSION=v0.1.0 sh

指定安裝目錄

標題為「指定安裝目錄」的章節
Terminal window
curl -fsSL https://raw.githubusercontent.com/r05323028/chronicle/main/install.sh \
  | CHRONICLE_INSTALL_DIR=/some/path sh

手動安裝發行版本

標題為「手動安裝發行版本」的章節

安裝器無法執行時，請使用這個方式：

  1. 從 GitHub Release 下載相符的 chronicle-<version>-<target>.tar.gz 與 SHA256SUMS。

  2. 解壓縮前先驗證封存檔。

    Terminal window
    sha256sum -c SHA256SUMS

  3. 解壓縮封存檔，並將頂層的 chronicle 二進位檔放到 PATH 中。

  4. 執行 chronicle --version 與 chronicle doctor。

發行流程會提供 x86_64-unknown-linux-gnu 與 aarch64-unknown-linux-gnu 封存檔。其他平台請勿自行猜測 target 名稱。

從原始碼建置

標題為「從原始碼建置」的章節

工作區會在 rust-toolchain.toml 中固定 Rust 工具鏈：

Terminal window
git clone https://github.com/r05323028/chronicle
cd chronicle
cargo build --release --locked

Linux 建置會包含已提交到儲存庫的 eBPF 擷取物件。其他平台提供不含 live capture 的可攜功能：列出、檢查、重播規劃與驗證、doctor，以及 fixture 錄製。

只有 eBPF pipeline 開發需要使用儲存庫 README 所述的獨立 nightly 重建流程。建置後執行 chronicle doctor，查看目前主機支援哪些功能。

live capture 的主機需求

標題為「live capture 的主機需求」的章節
  • 發行版本二進位檔 target 為小端序 x86_64 與 aarch64／arm64。
  • 0.1 保留的 live capture 執行驗證環境是 Ubuntu 24.04、Linux 6.8、aarch64。
  • 其他 Linux 6.1+ 核心與 x86_64 需要相符的 privileged acceptance；二進位檔可建置不代表 runtime 支援。
  • 啟用 cgroup v2，/sys/kernel/btf/vmlinux 提供 BTF，並具備必要 eBPF capability。
  • 錄製程序需要 CAP_BPF 與 CAP_NET_ADMIN。
  • 二進位檔中包含內嵌的擷取程式。

應用程式必須提供明文 HTTP/1.1 流量。目前的擷取路徑無法解讀 TLS 密文。