docs(EXC-1744): Document canister backtraces #5185
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
-16
to
+17
| docs/developer-docssmart-contracts/advanced-features/simd.mdx @dfinity/execution | ||
| docs/developer-docssmart-contracts/advanced-features/periodic-tasks.mdx @dfinity/execution | ||
| docs/developer-docs/smart-contracts/advanced-features/simd.mdx @dfinity/execution | ||
| docs/developer-docs/smart-contracts/advanced-features/periodic-tasks.mdx @dfinity/execution |
There was a problem hiding this comment.
Unrelated change, just fixing a typo.
|
🤖 Here's your preview: https://hjalc-kqaaa-aaaam-abagq-cai.icp0.io |
jessiemongeon1
requested changes
Feb 13, 2025
|
|
||
| <MarkdownChipRow labels={["Intermediate", "Tutorial", "Motoko", "Rust"]} /> | ||
|
|
||
| ## Intro |
There was a problem hiding this comment.
Suggested change
| ## Intro |
|
|
||
| ## Intro | ||
|
|
||
| Are you developing a Rust or Motoko <GlossaryTooltip>canister</GlossaryTooltip> encountering a confusing trap? Backtraces may help you pinpoint the location of the error. When canisters trap, ICP reports backtraces which contain the names of functions in the call stack. For example, if the following Rust canister accidentally performs an out of bounds access of stable memory: |
There was a problem hiding this comment.
Suggested change
| Are you developing a Rust or Motoko <GlossaryTooltip>canister</GlossaryTooltip> encountering a confusing trap? Backtraces may help you pinpoint the location of the error. When canisters trap, ICP reports backtraces which contain the names of functions in the call stack. For example, if the following Rust canister accidentally performs an out of bounds access of stable memory: | |
| When canisters trap, ICP reports backtraces that contain the names of functions in the call stack. Backtraces are added to the canister logs and if the caller has [access to canister logs](/docs/current/developer-docs/smart-contracts/maintain/logs#log-visibility) they will also be included in the message error response. | |
| For example, if the following Rust canister accidentally performs an out of bounds access of stable memory: |
| } | ||
| ``` | ||
|
|
||
| then the resulting stable memory out of bounds error will also contain the following backtrace which can help determine that the error is in `inner_2` which is reached via `outer` and `inner`: |
There was a problem hiding this comment.
Suggested change
| then the resulting stable memory out of bounds error will also contain the following backtrace which can help determine that the error is in `inner_2` which is reached via `outer` and `inner`: | |
| The resulting stable memory out of bounds error will also contain the following backtrace which can help determine that the error is in `inner_2` which is reached via `outer` and `inner`: |
| _wasm_backtrace_canister::outer | ||
| ``` | ||
|
|
||
| ## Where to find backtraces |
There was a problem hiding this comment.
Suggested change
| ## Where to find backtraces |
|
|
||
| ## Where to find backtraces | ||
|
|
||
| Backtraces are added to the canister logs and if the caller has [access to canister logs](/docs/current/developer-docs/smart-contracts/maintain/logs#log-visibility) they will also be included in the message error response. |
There was a problem hiding this comment.
Suggested change
| Backtraces are added to the canister logs and if the caller has [access to canister logs](/docs/current/developer-docs/smart-contracts/maintain/logs#log-visibility) they will also be included in the message error response. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
EXC-1744: https://dfinity.atlassian.net/browse/EXC-1744
Thank you for your contribution to the IC Developer Portal. This repo contains the content for https://internetcomputer.org and the ICP Developer Documentation, https://internetcomputer.org/docs/.
If you are submitting a Pull Request for adding or changing content on the ICP Developer Documentation, please make sure that your contribution meets the following requirements:
.mdxfile format to support the previous two components./sidebars.js, otherwise, it will not appear in theside navigation bar.
.github/CODEOWNERSfile isfilled with new documents that you added. This way we can ensure that future Pull Requests are reviewed by the right people.