Add memory_metrics to canister_status. #5240
Merged
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
q-uint
force-pushed
the
feature/quint/memory-size-details
branch
from
c5d65e5 to
a6540e6
Compare
dsarlis
reviewed
Feb 13, 2025
dsarlis
added
interface-spec
dsarlis
added a commit
that referenced
this pull request
Feb 13, 2025
When a PR is submitted from a fork from an external contributor, the workflow that attempts to add the `interface-spec` label fails, e.g. on this [PR](#5240). According to actions/labeler#36 (comment) this should be fixed by changing the type of action that triggers the workflow from `pull_request` to `pull_request_target` as this adds the necessary write permissions through a github token.
dsarlis
added a commit
that referenced
this pull request
Feb 14, 2025
When a PR is submitted from a fork from an external contributor, the workflow that attempts to add the `interface-spec` label fails, e.g. on this [PR](#5240). According to actions/labeler#36 (comment) this should be fixed by changing the type of action that triggers the workflow from `pull_request` to `pull_request_target` as this adds the necessary write permissions through a github token.
dsarlis
added
interface-spec
github-actions
bot
added
the
interface-spec
dragoljub-duric
previously approved these changes
Feb 17, 2025
dsarlis
previously approved these changes
Feb 17, 2025
dragoljub-duric
previously approved these changes
Feb 17, 2025
github-actions
bot
dismissed stale reviews from dragoljub-duric, dsarlis, and dragoljub-duric
Review dismissed by automation script.
mraszyk
reviewed
Feb 18, 2025
mraszyk
reviewed
Feb 18, 2025
dsarlis
previously approved these changes
Feb 21, 2025
mraszyk
reviewed
Feb 21, 2025
github-actions
bot
dismissed
dsarlis’s stale review
Review dismissed by automation script.
dsarlis
previously approved these changes
Feb 21, 2025
q-uint
added a commit
to CycleOperators/ic
that referenced
this pull request
Feb 25, 2025
- Introduced new memory metrics fields in `CanisterStatusResultV2`, including: - `wasm_memory_size` - `stable_memory_size` - `global_memory_size` - `wasm_binary_size` - `custom_sections_size` - `canister_history_size` - `wasm_chunk_store_size` - `snapshots_size` - Updated `CanisterManager` and `CanisterState` to compute and track these new metrics. - Refactored `ExecutionState` to provide individual methods for retrieving specific memory usage values. - Modified tests to validate the new memory metrics in canister status responses. This change improves visibility into canister memory consumption, aiding debugging and resource management. Refer to [PR portal#5240](dfinity/portal#5240) for more details.
q-uint
added a commit
to CycleOperators/ic
that referenced
this pull request
Feb 25, 2025
- Introduced new memory metrics fields in `CanisterStatusResultV2`, including: - `wasm_memory_size` - `stable_memory_size` - `global_memory_size` - `wasm_binary_size` - `custom_sections_size` - `canister_history_size` - `wasm_chunk_store_size` - `snapshots_size` - Updated `CanisterManager` and `CanisterState` to compute and track these new metrics. - Refactored `ExecutionState` to provide individual methods for retrieving specific memory usage values. - Modified tests to validate the new memory metrics in canister status responses. This change improves visibility into canister memory consumption, aiding debugging and resource management. Refer to [PR portal#5240](dfinity/portal#5240) for more details.
Dfinity-Bjoern
previously approved these changes
Feb 25, 2025
dsarlis
pushed a commit
to dfinity/ic
that referenced
this pull request
Feb 25, 2025
- Introduced new memory metrics fields in `CanisterStatusResultV2`, including: - `wasm_memory_size` - `stable_memory_size` - `global_memory_size` - `wasm_binary_size` - `custom_sections_size` - `canister_history_size` - `wasm_chunk_store_size` - `snapshots_size` - Updated `CanisterManager` and `CanisterState` to compute and track these new metrics. - Refactored `ExecutionState` to provide individual methods for retrieving specific memory usage values. - Modified tests to validate the new memory metrics in canister status responses. This change improves visibility into canister memory consumption, aiding debugging and resource management. Refer to [PR portal#5240](dfinity/portal#5240) for more details.
github-merge-queue bot
pushed a commit
to dfinity/ic
that referenced
this pull request
Feb 25, 2025
) ## Acknowledgements This contribution was made by @q-uint and @ByronBecker and was reviewed by me in their [fork](https://github.com/CycleOperators/ic) of the `ic` repo. I'm transferring over the two commits implementing the change on behalf of them as the `ic` repo does not (formally) accept external contributions yet. ## Changes included - Introduced new memory metrics fields in `CanisterStatusResultV2`, including: - `wasm_memory_size` - `stable_memory_size` - `global_memory_size` - `wasm_binary_size` - `custom_sections_size` - `canister_history_size` - `wasm_chunk_store_size` - `snapshots_size` - Updated `CanisterManager` and `CanisterState` to compute and track these new metrics. - Refactored `ExecutionState` to provide individual methods for retrieving specific memory usage values. - Modified tests to validate the new memory metrics in canister status responses. This change improves visibility into canister memory consumption, aiding debugging and resource management. Refer to [PR portal#5240](dfinity/portal#5240) for more details. ## Original PRs for reference - Main change: CycleOperators#1 - Lint fixes: CycleOperators#2 --------- Co-authored-by: Quint Daenen <[email protected]>
mraszyk
reviewed
Mar 10, 2025
There was a problem hiding this comment.
@q-uint Could you please update the changelog at docs/references/_attachments/interface-spec-changelog.md: e.g.,
### 0.34.0 (2025-03-07) {#0_34_0}
* New canister method `canister_on_low_wasm_memory` invoked when the canister is low on main memory according to a new `wasm_memory_threshold` in canister settings.
* New system APIs `ic0.cost_call`, `ic0.cost_create_canister`, `ic0.cost_http_request`, `ic0.cost_sign_with_ecdsa`, `ic0.cost_sign_with_schnorr`, and `ic0.cost_vetkd_derive_encrypted_key` for cycles cost calculation.
* New field `memory_metrics` providing detailed metrics on the memory consumption of a canister in the response of the management canister's `canister_status` endpoint.
Review dismissed by automation script.
auto-merge was automatically disabled
March 10, 2025 19:11
Head branch was pushed to by a user without write access
mraszyk
approved these changes
Mar 10, 2025
ggreif
added a commit
to dfinity/motoko
that referenced
this pull request
Mar 15, 2025
ggreif
added a commit
to dfinity/motoko
that referenced
this pull request
Mar 15, 2025
mergify bot
pushed a commit
to dfinity/motoko
that referenced
this pull request
Mar 17, 2025
See: dfinity/portal#5240. I have also filed krpeacock/ic-management-canister#1.
3 tasks
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.
This PR introduces
memory_metricstocanister_status, providing a more detailed breakdown of canister memory usage. This enhancement aims to improve visibility into memory consumption, aiding in better monitoring and debugging.Tagging relevant contributors:
@ByronBecker (@CycleOperators)
@dsarlis & @mraszyk