unc-o11y 0.2.0

Observability helpers for the near codebase
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

/// Internal use only.
#[macro_export]
macro_rules! handler_span {
    (target: $target:expr, level: $lvl:expr, $msg:expr, $($extra_fields:tt)*) => {{
        let WithSpanContext { msg, context, .. } = $msg;
        let span = tracing::span!(
            target: $target,
            $lvl,
            "handle",
            handler = unc_o11y::macros::type_name_of(&msg),
            actor = unc_o11y::macros::last_component_of_name(std::any::type_name::<Self>()),
            $($extra_fields)*)
        .entered();
        span.set_parent(context);
        (span, msg)
    }};
}

/// A macro that lets attach `handle()` functions to the tracing context that
/// generated the actix message being processed.
/// Creates a DEBUG-level span with the handler type name and the message type name as attributes.
#[macro_export]
macro_rules! handler_debug_span {
    (target: $target:expr, $msg:expr) => {
        $crate::handler_span!(target: $target, level: tracing::Level::DEBUG, $msg, )
    };
    (target: $target:expr, $msg:expr, $($extra_fields:tt)*) => {
        $crate::handler_span!(target: $target, level: tracing::Level::DEBUG, $msg, $($extra_fields)*)
    };
}

/// A macro that lets attach `handle()` functions to the tracing context that
/// generated the actix message being processed.
/// Creates a TRACE-level span with the handler type name and the message type name as attributes.
#[macro_export]
macro_rules! handler_trace_span {
    (target: $target:expr, $msg:expr) => {
        $crate::handler_span!(target: $target, level: tracing::Level::TRACE, $msg, )
    };
    (target: $target:expr, $msg:expr, $($extra_fields:tt)*) => {
        $crate::handler_span!(target: $target, level: tracing::Level::TRACE, $msg, $($extra_fields)*)
    };
}

/// For internal use by `handler_span!`.
/// Given 'abc::bcd::cde' returns 'cde'.
/// Given 'abc' returns 'abc'.
pub fn last_component_of_name(name: &str) -> &str {
    name.rsplit_once("::").map_or(name, |(_, name)| name)
}

/// For internal use by `handler_span!`.
/// Returns the last component of the name of type `T`.
pub fn type_name_of<T>(_: &T) -> &str {
    last_component_of_name(std::any::type_name::<T>())
}