#spans #snapshot #tracing #log #log-level #test

test-span

macro and utilities to do snapshot tests on tracing spans

9 releases (breaking)

0.8.0 May 4, 2024
0.7.0 Aug 5, 2022
0.6.0 May 5, 2022
0.5.0 May 3, 2022
0.1.1 Jan 10, 2022

#85 in Testing

Download history 181/week @ 2024-02-29 185/week @ 2024-03-07 188/week @ 2024-03-14 203/week @ 2024-03-21 233/week @ 2024-03-28 238/week @ 2024-04-04 182/week @ 2024-04-11 186/week @ 2024-04-18 189/week @ 2024-04-25 464/week @ 2024-05-02 272/week @ 2024-05-09 318/week @ 2024-05-16 196/week @ 2024-05-23 234/week @ 2024-05-30 278/week @ 2024-06-06 293/week @ 2024-06-13

1,087 downloads per month
Used in 3 crates

MIT/Apache

33KB
632 lines

test-span

A macro and utilities to do snapshot tests on tracing spans.

docs Build status Apache 2.0 License MIT License

How to use

Refer to the tests for a more exhaustive list of features and behaviors:

use test_span::prelude::*;

#[test_span]
fn a_test() {
    do_something();

    // test_span provides your with three functions:
    let spans = get_spans();
    let logs = get_logs();
    // you can get both in one call
    let (spans, logs) = get_telemetry();

    // This plays well with insta snapshots:
    insta::assert_json_snapshot!(logs);
    insta::assert_json_snapshot!(spans);
}

// Test span plays well with async
#[test_span(tokio::test)]
// you can specify the span / log level
// you would like to track like this:
#[level(tracing::Level::INFO)]
async fn an_sync_test() {
    do_something_async().await;
    // You still get access to each function
    let spans = get_spans();
    let logs = get_logs();
    let (spans, logs) = get_telemetry();
}

Limitations

Spans and logs are hard to track across thread spawns. However we're providing you with a log dump you can check:

#[test_span]
fn track_across_threads() {
    std::thread::spawn(|| {
        tracing::info!("only in get_all_logs!");
    })
    .join()
    .unwrap();

    let logs = get_logs();
    // not in get_logs()
    assert!(!logs.contains_message("only in get_all_logs!");

    // get_all_logs takes a filter Level
    let all_logs = test_span::get_all_logs(&tracing::Level::INFO);
    assert!(all_logs.contains_message("only in get_all_logs!"));
}

Contributing

More information can be found in the contribution docs

License

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~10–19MB
~219K SLoC