canic-core 0.21.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

use crate::dto::prelude::*;

///
/// Metrics DTOs
///
/// WHY THIS MODULE EXISTS
/// ----------------------
/// This module defines the **public, serialized representation** of metrics
/// exposed by the system.
///
/// These types are:
/// - Read-only snapshots
/// - Emitted at query/read time
/// - Detached from internal storage or aggregation strategy
///
/// Invariants:
/// - These structs MUST remain stable across upgrades.
/// - They MUST NOT encode internal metric layout or backend details.
/// - Cardinality must remain bounded by design.
///
/// Any change here affects:
/// - External dashboards
/// - Monitoring integrations
/// - Long-term metric continuity
///
/// Treat changes as **breaking API changes**.
///

///
/// MetricsKind
///
/// Metric family selector for the unified metrics query endpoint.
///

#[derive(CandidType, Clone, Copy, Deserialize)]
pub enum MetricsKind {
    System,
    Icc,
    Http,
    Timer,
    Access,
    Delegation,
    RootCapability,
    CyclesFunding,
    Perf,
}

///
/// MetricEntry
///
/// Unified metrics row for all query families.
///
/// The requested `MetricsKind` defines the meaning of `value`.
///

#[derive(CandidType, Deserialize)]
pub struct MetricEntry {
    /// Ordered, low-cardinality labels for the requested metric family.
    pub labels: Vec<String>,

    /// Optional principal dimension.
    pub principal: Option<Principal>,

    /// Metric payload for the requested family.
    pub value: MetricValue,
}

///
/// MetricValue
///

#[derive(CandidType, Deserialize)]
pub enum MetricValue {
    Count(u64),
    CountAndU64 { count: u64, value_u64: u64 },
    U128(u128),
}