Skip to content

Commit ea39fa1

Browse files
authored
Merge pull request #1100 from 552020/patch-2
Update README.md - Add short description
2 parents 910c1b9 + 4113a4d commit ea39fa1

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

motoko/canister_logs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Canister logs
22

3-
This project demonstrates how to use canister logs on ICP.
3+
This sample project demonstrates a basic logging and error handling system for a canister deployed on the Internet Computer. The `canister_logs` project showcases how to utilize logging for debugging and monitoring canister operations. It also demonstrates the use of timers and error handling through traps.
4+
5+
The `canister_logs` canister is designed to periodically log messages and simulate errors using traps. It provides methods to print messages, trigger traps, and handle memory out-of-bounds errors. The project includes a script to continuously poll and display logs, making it easier to monitor canister activity in real-time.
6+
7+
## Prerequisites
8+
9+
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/getting-started/install). For local testing, `dfx >= 0.22.0` is required.
10+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
411

512
## Deploying from ICP Ninja
613

rust/canister_logs/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Canister logs
22

3+
This sample project demonstrates a basic logging and error handling system for a canister deployed on the Internet Computer. The `canister_logs` project showcases how to utilize logging for debugging and monitoring canister operations. It also demonstrates the use of timers and error handling through traps.
4+
5+
The `canister_logs` canister is designed to periodically log messages and simulate errors using traps. It provides methods to print messages, trigger traps, and handle memory out-of-bounds errors. The project includes a script to continuously poll and display logs, making it easier to monitor canister activity in real-time.
6+
7+
## Prerequisites
8+
9+
- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/getting-started/install). For local testing, `dfx >= 0.22.0` is required.
10+
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
11+
312
## Deploying from ICP Ninja
413

514
When viewing this project in ICP Ninja, you can deploy it directly to the mainnet for free by clicking "Run" in the upper right corner. Open this project in ICP Ninja:
@@ -24,6 +33,7 @@ dfx start --clean
2433
```
2534

2635
You will need to have 3 terminal windows:
36+
2737
- Terminal A: Running a `dfx` instance and separating its output from anything else.
2838
- Terminal B: Deploying a canister and seeing its output.
2939
- Terminal C: Reading logs interactively.
@@ -144,4 +154,4 @@ Observe recorded logs that might look similar to this:
144154
[37. 2024-05-23T08:33:36.712223153Z]: [TRAP]: timer trap
145155
...
146156

147-
```
157+
```

0 commit comments

Comments
 (0)