canic-core 0.110.50

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

//! Module: ids::metrics
//!
//! Responsibility: metric classification identifiers.
//! Does not own: metric storage, aggregation, or emission.
//! Boundary: exposes stable categories used by access and system metrics.

use serde::{Deserialize, Serialize};

///
/// AccessMetricKind
///
/// Enumerates the access predicate kind that rejected the call.
/// Access metrics are emitted only on denial.
/// Custom predicates report AccessMetricKind::Custom.
/// Predicate names are recorded separately alongside the kind.
/// Owned by ids and consumed by access metrics adapters.
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
#[remain::sorted]
pub enum AccessMetricKind {
    Auth,
    Custom,
    Env,
    Guard,
    Rule,
}

impl AccessMetricKind {
    /// Return the stable metric label for this access metric kind.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Auth => "auth",
            Self::Custom => "custom",
            Self::Env => "env",
            Self::Guard => "guard",
            Self::Rule => "rule",
        }
    }
}