#internet-computer #canister #logging #dfinity #smart-contracts #circular-buffer

ic-canister-log

A logging library for smart contracts running on the Internet Computer

2 unstable releases

0.2.0 Jul 4, 2023
0.1.0 May 10, 2023

#38 in #circular-buffer

Download history 2968/week @ 2024-03-14 2998/week @ 2024-03-21 2612/week @ 2024-03-28 3312/week @ 2024-04-04 2644/week @ 2024-04-11 3288/week @ 2024-04-18 2711/week @ 2024-04-25 3028/week @ 2024-05-02 2941/week @ 2024-05-09 3094/week @ 2024-05-16 3543/week @ 2024-05-23 4245/week @ 2024-05-30 3666/week @ 2024-06-06 3771/week @ 2024-06-13 3347/week @ 2024-06-20 2765/week @ 2024-06-27

14,208 downloads per month
Used in ic-canister-serve

Apache-2.0

9KB
130 lines

IC Canister Log

This package provides a basic logging library for smart contracts running on the Internet Computer (also known as canisters).

Usage

Macros declare_log_buffer and log are the core library interface. The declare_log_buffer macros creates a circular buffer of messages with the specified capacity. The log macro formats and appends messages to a buffer.

You can extract messages from the log buffer using the export function.

use ic_canister_log::{declare_log_buffer, export, log};

// Keep up to 100 last messages.
declare_log_buffer!(name = LOG, capacity = 100);

fn sum_and_log(x: u64, y: u64) -> u64 {
   let result = x.saturating_add(y);
   log!(LOG, "{} + {} = {}", x, y, result);
   result
}

fn print_log_entries() {
  for entry in export(&LOG) {
    println!("{}:{} {}", entry.file, entry.line, entry.message);
  }
}

Dependencies

~0.4–1MB
~22K SLoC