canic-core 0.110.10

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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! Module: ops::runtime::metrics::auth::sessions
//!
//! Responsibility: record low-cardinality local application-session outcomes.
//! Does not own: session storage, delegated-token verification, or endpoint DTOs.
//! Boundary: auth API/workflow records typed outcomes without identity or scope labels.

use crate::ops::runtime::metrics::auth::{
    AuthMetricOperation, AuthMetricOutcome, AuthMetricReason, AuthMetricSurface, AuthMetrics,
};

/// Record one local application-session establishment attempt.
pub fn record_application_session_establishment_started() {
    record(
        AuthMetricOperation::Establish,
        AuthMetricOutcome::Started,
        AuthMetricReason::Request,
    );
}

/// Record a newly created local application session.
pub fn record_application_session_created() {
    record(
        AuthMetricOperation::Establish,
        AuthMetricOutcome::Completed,
        AuthMetricReason::Created,
    );
}

/// Record an atomic local application-session replacement.
pub fn record_application_session_replaced() {
    record(
        AuthMetricOperation::Establish,
        AuthMetricOutcome::Completed,
        AuthMetricReason::Replaced,
    );
}

/// Record a byte-identical establishment retry.
pub fn record_application_session_idempotent() {
    record(
        AuthMetricOperation::Establish,
        AuthMetricOutcome::Idempotent,
        AuthMetricReason::Replay,
    );
}

/// Record a bounded establishment rejection class.
pub fn record_application_session_rejected(reason: AuthMetricReason) {
    record(
        AuthMetricOperation::Establish,
        AuthMetricOutcome::Rejected,
        reason,
    );
}

/// Record caller-scoped clear, distinguishing missing-state idempotence.
pub fn record_application_session_clear(removed: bool) {
    record(
        AuthMetricOperation::Clear,
        if removed {
            AuthMetricOutcome::Completed
        } else {
            AuthMetricOutcome::Idempotent
        },
        AuthMetricReason::Cleared,
    );
}

/// Record one strict-expiry observation outside the pure authorization function.
pub fn record_application_session_expired_observation() {
    record(
        AuthMetricOperation::ExpiryObservation,
        AuthMetricOutcome::Completed,
        AuthMetricReason::Expired,
    );
}

/// Record the bounded number of expired records removed by one cleanup call.
#[cfg(any(test, feature = "auth-local-application-authorization"))]
pub fn record_application_session_cleanup(removed: usize) {
    for _ in 0..removed {
        record(
            AuthMetricOperation::Cleanup,
            AuthMetricOutcome::Completed,
            AuthMetricReason::Expired,
        );
    }
}

/// Record one local authority-generation invalidation.
pub fn record_application_session_generation_invalidation() {
    record(
        AuthMetricOperation::GenerationInvalidation,
        AuthMetricOutcome::Completed,
        AuthMetricReason::GenerationAdvanced,
    );
}

fn record(operation: AuthMetricOperation, outcome: AuthMetricOutcome, reason: AuthMetricReason) {
    AuthMetrics::record(
        AuthMetricSurface::ApplicationSession,
        operation,
        outcome,
        reason,
    );
}