canic-core 0.34.3

Canic — a canister orchestration and management toolkit for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use super::*;

impl MgmtOps {
    /// Create a canister snapshot via the management canister and record metrics.
    pub async fn take_canister_snapshot(
        canister_pid: Principal,
        replace_snapshot: Option<Vec<u8>>,
        uninstall_code: Option<bool>,
    ) -> Result<CanisterSnapshot, InternalError> {
        record_unscoped_canister_op(
            CanisterOpsMetricOperation::Snapshot,
            CanisterOpsMetricOutcome::Started,
            CanisterOpsMetricReason::Ok,
        );

        match management_call(
            ManagementCallMetricOperation::TakeCanisterSnapshot,
            MgmtInfra::take_canister_snapshot(canister_pid, replace_snapshot, uninstall_code),
        )
        .await
        {
            Ok(snapshot) => {
                record_unscoped_canister_op(
                    CanisterOpsMetricOperation::Snapshot,
                    CanisterOpsMetricOutcome::Completed,
                    CanisterOpsMetricReason::Ok,
                );
                log!(
                    Topic::CanisterLifecycle,
                    Ok,
                    "take_canister_snapshot: {canister_pid} total_size={}",
                    snapshot.total_size
                );
                Ok(canister_snapshot_from_infra(snapshot))
            }
            Err(err) => {
                record_unscoped_canister_op(
                    CanisterOpsMetricOperation::Snapshot,
                    CanisterOpsMetricOutcome::Failed,
                    CanisterOpsMetricReason::from_error(&err),
                );
                Err(err)
            }
        }
    }

    /// Restore a canister from a snapshot via the management canister and record metrics.
    pub async fn load_canister_snapshot(
        canister_pid: Principal,
        snapshot_id: Vec<u8>,
    ) -> Result<(), InternalError> {
        record_unscoped_canister_op(
            CanisterOpsMetricOperation::Restore,
            CanisterOpsMetricOutcome::Started,
            CanisterOpsMetricReason::Ok,
        );

        match management_call(
            ManagementCallMetricOperation::LoadCanisterSnapshot,
            MgmtInfra::load_canister_snapshot(canister_pid, snapshot_id),
        )
        .await
        {
            Ok(()) => {
                record_unscoped_canister_op(
                    CanisterOpsMetricOperation::Restore,
                    CanisterOpsMetricOutcome::Completed,
                    CanisterOpsMetricReason::Ok,
                );
                log!(
                    Topic::CanisterLifecycle,
                    Ok,
                    "load_canister_snapshot: {canister_pid}"
                );
                Ok(())
            }
            Err(err) => {
                record_unscoped_canister_op(
                    CanisterOpsMetricOperation::Restore,
                    CanisterOpsMetricOutcome::Failed,
                    CanisterOpsMetricReason::from_error(&err),
                );
                Err(err)
            }
        }
    }
}