此crate的主要目的是允许Rust程序使用TOML配置文件来配置跟踪和跟踪订阅者crate。更多详细信息请参阅crate文档。

使用cargo doc生成文档

lib.rs:

此crate的主要目的是允许Rust程序使用TOML配置文件来配置[tracing][mod@t]和[tracing-subscriber][mod@ts]crate。

此crate不打算由库作者使用。如果你的项目包含lib.rs文件，请从你的Cargo.toml项目文件中移除tracing-config。

性能损失/内存开销

如果您使用此crate构建和设置全局的tracing [Subscriber][trait@t::Subscriber]，则其实现将是一个tracing-subscriber [Registry][struct@ts::registry::Registry]，并且添加到该Registry的所有Layer [trait@ts::Layer]将使用动态分发Box<dyn Layer>。此外，tracing-config的自身SpanRecordLayer [struct@tracing::SpanRecordLayer]将被添加到Registry中，紧接在根EnvFilter [struct@ts::filter::EnvFilter]之后，这将基本上保留所有（非过滤掉的）Span [data/field][mod@t::field]s的内存表示，实际上抵消了由tracing "访问者模式"（参见Visit [trait@t::field::Visit])带来的任何性能提升，该模式不保留任何事件的内存表示；这利用了tracing-subscriber Span [Extensions][struct@ts::registry::Extensions]。

如果您怀疑您的应用程序由于跟踪配置而遭受性能损失

• 提交一个错误报告
• 尝试使用更严格的过滤器或完全删除一些高冗余的跟踪事件（参见level_filters [mod@t::level_filters])
• 考虑发出更少的事件，您不应该使用跟踪来调试应用程序，而应该使用调试器。
• 尝试在main()中手动构建您的订阅者，这样做可以消除对动态分发层的需要。
• 最后，您可以从您的Cargo.toml项目文件中删除tracing-config，并找到另一种配置跟踪的方法。

鉴于有大量只使用动态分发或高度依赖于动态分发进行日志/跟踪的编程语言，我认为在Rust中具有相同的功能不是什么大问题，尤其是因为一旦您的配置足够成熟，您就可以轻松构建您的订阅者而无需动态分发。

入门

# Cargo.toml
tracing-config = { version = "0.1" }
tracing = { version = "0.1", features = [
    "max_level_trace", # compile time static, removes tracing macro calls at compile time for debug builds
    "release_max_level_trace" # compile time static, removes tracing macro calls at compile time for release builds
]}
tracing-subscriber = { version = "0.3", features = [
    "chrono", # timestamps
    "registry", # shared span storage and base subscriber
    "env-filter", # filter events/spans at runtime
    "fmt", # event/span formatter
    "ansi", # for color terminal output
    "json", # json
]}
tracing-appender = { version = "0.2" } # allows events and spans to be recorded in a non-blocking manner

// main.rs
use tracing::info;
use tracing::info_span;
fn main() {
    // Beware, the init() function panics ! Read the docs.
    // Careful not to drop the guard early, this results in a panic in certain cases.
    let _tc_guard = tracing_config::init();
    info_span!("main");
    info!("Hello World");
}

对于测试

 // some_module.rs
 use tracing::info;
 use tracing::info_span;
 #[test]
 fn test_some_functionality() {
     // Beware, the init_test() function panics ! Read the docs.
     // Careful not to drop the guard early, this results in a panic in certain cases.
     let _tc_guard = tracing_config::init_test();
     info_span!("functionality test");
     info!("Hello World");
 }

配置文件搜索路径

init [fn@init]函数将加载一个tracing.toml配置文件，给定默认的搜索路径。要了解search path，请阅读[find_config_path][fn@config::find_config_path]的文档，或者通过设置环境变量tracing_config_debug=true启用debug_mode，并监视程序的标准输出。

# tracing.toml
title = "Pretty colored ts-fmt to stdout"

[layer.ts-fmt]
type = "fmt"
writer = "stdout"
formatter = "pretty"
span_events = "none"
ansi = true

[writer.stdout]
type = "standard_output"

[filter.root]
level = "trace"