prima-tracing 0.23.0

Prima.it opentelemetry standard library
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
64
65
66
67
68
69
70

pub mod error_report;

/// Emit a tracing error event for an error with rich, structured context.
/// It captures the error using the experimental Rust [std::error::Report](https://doc.rust-lang.org/stable/std/error/struct.Report.html)
/// and adding the type name as error.kind, the backtrace as error.trace and the error stack as error.message
///
/// # Examples
///
/// ```rust
/// use prima_tracing::trace_error;
/// # fn main() {
///
/// let error = "not a number".parse::<usize>().unwrap_err();
/// let extra_info = "extra info";
/// trace_error!(error, "Parsing error!");
/// trace_error!(error, uid="1234", "Parsing error: {extra_info}");
/// # }
/// ```
#[macro_export]
macro_rules! trace_error {
    ($error:expr, $($rest:tt)+) => {{
        let kind = std::any::type_name_of_val(&$error);
        let error_message = format!("{:#}", $error);
        let stack = prima_tracing::macros::error_report::Report::new(&$error);
        let trace = std::backtrace::Backtrace::force_capture();
        $crate::tracing::error!(
            error.message = error_message,
            error.kind = kind,
            error.stack = ?stack,
            error.trace = %trace,
            $($rest)+
        );
    }};
}

/// Emit a tracing error event for anyhow error with rich, structured context.
/// It captures the error using the experimental Rust [std::error::Report](https://doc.rust-lang.org/stable/std/error/struct.Report.html)
/// and adding the type name as error.kind, the backtrace as error.trace and the error stack as error.message
///
/// # Examples
///
/// ```rust
/// use anyhow::anyhow
/// use prima_tracing::trace_error;
/// # fn main() {
///
/// let error = anyhow!("an error");
/// let extra_info = "extra info";
/// trace_anyhow_error!(error, "Throw error!");
/// trace_anyhow_error!(error, uid="1234", "Parsing error: {extra_info}");
/// # }
/// ```
#[cfg(feature = "anyhow")]
#[macro_export]
macro_rules! trace_anyhow_error {
    ($error:expr, $($rest:tt)+) => {{
        let kind = std::any::type_name_of_val(&$error.root_cause());
        let error_message = format!("{:#}", $error);
        let std_err: &(dyn std::error::Error + 'static) = $error.as_ref();
        let stack = prima_tracing::macros::error_report::Report::new(std_err);
        let trace = $error.backtrace();
        $crate::tracing::error!(
            error.message = error_message,
            error.kind = kind,
            error.stack = ?stack,
            error.trace = %trace,
            $($rest)+
        );
    }};
}