canic_core/
log.rs

1use crate::{model::memory::env::Env, ops::runtime::log::LogOps};
2use candid::CandidType;
3use derive_more::Display;
4use serde::{Deserialize, Serialize};
5use std::cell::Cell;
6
7///
8/// Debug
9///
10
11#[derive(
12    Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, CandidType, Display, Serialize, Deserialize,
13)]
14pub enum Level {
15    Debug, // least severe
16    Info,
17    Ok,
18    Warn,
19    Error, // most severe
20}
21
22///
23/// Topic
24///
25
26#[derive(Clone, Copy, Display, Eq, PartialEq)]
27#[remain::sorted]
28pub enum Topic {
29    App,
30    Auth,
31    CanisterLifecycle,
32    CanisterPool,
33    CanisterState,
34    Cycles,
35    Init,
36    Memory,
37    Perf,
38    Sharding,
39    Sync,
40    Topology,
41    Wasm,
42}
43
44thread_local! {
45    static LOG_READY: Cell<bool> = const { Cell::new(false) };
46}
47
48pub fn set_ready() {
49    LOG_READY.with(|ready| ready.set(true));
50}
51
52#[must_use]
53pub fn is_ready() -> bool {
54    LOG_READY.with(Cell::get)
55}
56
57#[macro_export]
58macro_rules! log {
59    // =========================================
60    // (1) With topic (normal + trailing comma)
61    // =========================================
62    ($topic:expr, $level:ident, $fmt:expr $(, $arg:expr)* $(,)?) => {{
63        $crate::log!(@inner Some(&$topic.to_string()), $crate::log::Level::$level, $fmt $(, $arg)*);
64    }};
65
66    // =========================================
67    // (2) No topic (normal + trailing comma)
68    // =========================================
69    ($level:ident, $fmt:expr $(, $arg:expr)* $(,)?) => {{
70        $crate::log!(@inner None::<&str>, $crate::log::Level::$level, $fmt $(, $arg)*);
71    }};
72
73    // =========================================
74    // INTERNAL
75    // =========================================
76    (@inner $topic:expr, $level:expr, $fmt:expr $(, $arg:expr)*) => {{
77        if $crate::log::is_ready() {
78            let level = $level;
79            let topic_opt: Option<&str> = $topic;
80            let message = format!($fmt $(, $arg)*);
81
82            // append entry
83            let crate_name = env!("CARGO_PKG_NAME");
84            let _ = $crate::log::__append_runtime_log(crate_name, topic_opt, level, &message);
85
86            let ty_raw = $crate::log::__canister_role_string().unwrap_or_else(|| "...".to_string());
87
88            let ty_disp = $crate::utils::format::ellipsize_middle(&ty_raw, 9, 4, 4);
89            let ty_centered = format!("{:^9}", ty_disp);
90
91            let final_msg = if let Some(t) = topic_opt {
92                format!("[{t}] {message}")
93            } else {
94                message
95            };
96
97            let (color, reset) = match level {
98                $crate::log::Level::Ok    => ("\x1b[32m", "\x1b[0m"),
99                $crate::log::Level::Info  => ("\x1b[34m", "\x1b[0m"),
100                $crate::log::Level::Warn  => ("\x1b[33m", "\x1b[0m"),
101                $crate::log::Level::Error => ("\x1b[31m", "\x1b[0m"),
102                $crate::log::Level::Debug => ("", ""),
103            };
104
105            let label = format!("{color}{:^5}{reset}", level.to_string().to_uppercase());
106            let line = format!("{label}|{ty_centered}| {final_msg}");
107
108            $crate::cdk::println!("{line}");
109        }
110    }};
111}
112
113///
114/// Helpers
115///
116
117#[doc(hidden)]
118pub fn __append_runtime_log(
119    crate_name: &str,
120    topic: Option<&str>,
121    level: Level,
122    message: &str,
123) -> Result<u64, crate::Error> {
124    LogOps::append_runtime_log(crate_name, topic, level, message)
125}
126
127#[doc(hidden)]
128#[must_use]
129pub fn __canister_role_string() -> Option<String> {
130    Env::get_canister_role().map(|role| role.to_string())
131}
canic_core/log.rs

canic_core/
log.rs
