tracing-error：為 Rust 錯誤處理註入診斷資訊

在軟體開發過程中，錯誤處理是至關重要的一環。清晰、詳盡的錯誤資訊能夠幫助開發者快速定位問題根源，提高偵錯效率。而 tracing 作為 Rust 生態中強大的日誌和診斷訊息方塊架，為我們提供了結構化、異步感知的診斷資訊收集能力。 tracing-error 則更進一步，將 tracing 的強大功能與 Rust 的錯誤處理機制相結合，為錯誤型別註入豐富的診斷資訊，從而極大地提升錯誤處理的效率和便利性。

核心元件

tracing-error 的核心元件包括：

1. SpanTrace：捕獲當前 tracing span 上下文

SpanTrace 結構體用於捕獲建立時的 tracing span 上下文，並支持在之後的時間點進行展示。

use std::{fmt, error::Error};
use tracing_error::SpanTrace;
#[derive(Debug)]
pubstructMyError {
context: SpanTrace,
// ...
}
impl fmt::Display for MyError {
fnfmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
// ... 格式化錯誤的其他部份 ...
self.context.fmt(f)?;
// ... 格式化其他錯誤上下文資訊、原因鏈等 ...
# Ok(())
}
}
impl Error for MyError {}
impl MyError {
pubfnnew() -> Self {
Self {
context: SpanTrace::capture(),
// ... 其他錯誤資訊 ...
}
}
}






2. TracedError：為已有錯誤附加 SpanTrace

TracedError 結構體用於將 SpanTrace 附加到現有的錯誤型別。我們可以使用 InstrumentResult 和 InstrumentError trait，或者 From / Into trait，方便地將錯誤包裝到 TracedError 中。

use tracing_error::prelude::*;
std::fs::read_to_string("myfile.txt").in_current_span()?;

獲取 TracedError 中的 SpanTrace 資訊可以透過三種方式：

use std::error::Error;
use tracing_error::ExtractSpanTrace as _;
fnprint_extracted_spantraces(error: &(dyn Error + 'static)) {
letmut error = Some(error);
letmut ind = 0;
eprintln!("Error:");
whileletSome(err) = error {
ifletSome(spantrace) = err.span_trace() {
eprintln!("found a spantrace:\n{}", spantrace);
} else {
eprintln!("{:>4}: {}", ind, err);
}
error = err.source();
ind += 1;
}
}




3. ErrorSubscriber：訂閱並捕獲 SpanTrace

ErrorSubscriber 是一個 tracing 訂閱器層，用於啟用 SpanTrace 的捕獲功能。

use tracing_error::ErrorSubscriber;
use tracing_subscriber::prelude::*;
fnmain() {
let subscriber = tracing_subscriber::Registry::default()
// 可以在 ErrorSubscriber 前後添加其他訂閱器層
.with(ErrorSubscriber::default());
// 設定全域預設訂閱器
tracing::subscriber::set_global_default(subscriber);
}


特性開關

tracing-error 提供以下特性開關：

總結

tracing-error 為 Rust 的錯誤處理機制註入了強大的診斷資訊，使得開發者能夠更輕松地定位和解決問題。透過 SpanTrace 、 TracedError 和 ErrorSubscriber 等核心元件，我們可以捕獲、附加和展示豐富的上下文資訊，從而顯著提升錯誤處理的效率和便利性。

文章精選

點 擊 關 註 並 掃 碼 添 加 進 交 流 群

領 取 「Rust 語 言 」 學 習 資 料