Rust 中記錄

本文將說明如何在 Fuchsia 上開始使用 Rust 程式的記錄功能。如需記錄及查看記錄的一般資訊，請參閱語言中立的記錄說明文件。

必要能力

請在元件資訊清單中加入下列項目，確保元件要求適當的記錄功能：

{
  include: [
    "syslog/client.shard.cml"
  ],
  ...
}

初始化

您必須先初始化記錄功能，才能透過 Rust 程式碼記錄記錄。初始化作業由 fuchsia crate 設定巨集處理。

GN 依附元件

請將下列 deps 新增至 BUILD.gn 檔案：

deps = [
  "//src/lib/fuchsia",
]

設定

在 Rust 來源檔案中，如果使用 fuchsia::main 或 fuchsia::test 巨集初始化任何函式，系統會預設啟用記錄功能：

#[fuchsia::main]
fn main() {
    // ...
}

#[fuchsia::test]
fn example_test() {
    // ...
}

您也可以傳遞 logging 標記，明確指定這項設定：

#[fuchsia::main(logging = true)]
fn main() {
    // ...
}

#[fuchsia::test(logging = true)]
fn example_test() {
    // ...
}

新增標記

記錄訊息可包含一或多個標記，以提供額外的背景資訊。如要為特定範圍啟用記錄標記，請在初始化期間傳遞 logging_tags 參數：

#[fuchsia::main(logging_tags = ["foo", "bar"])]
fn main() {
    // ...
}

#[fuchsia::test(logging_tags = ["foo", "bar"])]
fn example_test_with_tags() {
    // ...
}

記錄記錄

Fuchsia 上的 Rust 程式通常會使用 log crate 巨集來記錄記錄。

GN 依附元件

將 log Crate 新增至 BUILD.gn 檔案的 deps 項目：

deps = [
  "//third_party/rust_crates:log",
]

記錄事件

呼叫 log crate 提供的巨集，以宣告的嚴重性層級記錄記錄檔：

fn main() {
    log::trace!("something happened: {}", 5); // maps to TRACE
    log::debug!("something happened: {}", 4); // maps to DEBUG
    log::info!("something happened: {}", 3);  // maps to INFO
    log::warn!("something happened: {}", 2);  // maps to WARN
    log::error!("something happened: {}", 1); // maps to ERROR

    # You can also use the log crate to emit structured logs.
    log::info!(my_key = 3, other_key_debug:?; "something happened");
}

標準串流

println!、eprintln! 等 Rust 巨集會對應至標準輸出 (stdout) 和標準錯誤 (stderr)。使用這些串流可能需要為您的程式進行額外設定。

詳情請參閱語言中立記錄說明文件中的「標準串流」一節。