lyte-observer 1.0.0

A thin wrapper around my most commonly-used crates for error handling and reporting, tracing, observability, logs, etc.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

#[allow(unused_imports)]
pub mod prelude {
    pub mod crates {
        pub use color_eyre;
        pub use tracing;
        pub use tracing_subscriber;
    }
    pub use super::{observe, observe_info, trace_crate};
    pub use color_eyre::{Report, Result};
    pub use crates::*;
    pub use tracing::{debug, error, event, info, instrument, trace, warn, Instrument, Level};
    pub type Error = Report;
}

pub use prelude::crates::*;
use prelude::*;
pub use prelude::{Error, Report, Result};

#[instrument]
/// This function is marked unsafe because it's very likely you do not want to
/// do this.
///
/// Analagous to `observe("trace")`
pub unsafe fn very_verbosely_trace_everything() -> Result<()> {
    observe("trace")
}

#[instrument]
/// Analagous to `observe("info")`
pub fn observe_info() -> Result<()> {
    observe("info")
}

#[instrument]
/// Analagous to `observe(&format!("{}=trace,info", crate_name))`
pub fn trace_crate(crate_name: &str) -> Result<()> {
    observe(&format!("{}=trace,info", crate_name))
}

/// Sets up `color_eyre` and a basic logging tracing subscriber with the
/// specified `filter_str`. Everything a growing application needs.
#[instrument]
pub fn observe(filter_str: &str) -> Result<()> {
    color_eyre::install()?;

    // I'm guessing a v2 of this lib will involve a builder or registry so that
    // we can inject other subscribers for things like metrics exporters or file
    // loggers as well.
    let filter = tracing_subscriber::EnvFilter::builder()
        .with_default_directive(<tracing_subscriber::filter::Directive>::from(
            tracing::level_filters::LevelFilter::TRACE,
        ))
        .parse_lossy(filter_str);

    tracing_subscriber::fmt()
        // .pretty()
        .with_env_filter(filter)
        .init();

    debug!("setup complete");

    Ok(())
}