canic-core 0.95.1

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

//! Module: workflow::runtime::log
//!
//! Responsibility: schedule and run runtime log retention sweeps.
//! Does not own: log storage schemas, retention policy rules, or endpoint authorization.
//! Boundary: runtime workflow timer coordinating log policy and log ops.

use crate::{
    domain::policy::pure as policy,
    log,
    log::Topic,
    ops::{config::ConfigOps, ic::IcOps, runtime::log::LogOps},
    workflow::{
        config::{WORKFLOW_INIT_DELAY, WORKFLOW_LOG_RETENTION_INTERVAL},
        runtime::timer::{TimerKey, TimerWorkflow},
    },
};
use std::time::Duration;

const RETENTION_INTERVAL: Duration = WORKFLOW_LOG_RETENTION_INTERVAL;

///
/// LogRetentionWorkflow
///

pub struct LogRetentionWorkflow;

impl LogRetentionWorkflow {
    /// Start periodic log retention sweeps.
    pub fn start() {
        TimerWorkflow::ensure_recurring(
            TimerKey::LogRetention,
            WORKFLOW_INIT_DELAY,
            RETENTION_INTERVAL,
            || async {
                let _ = Self::retain();
            },
        );
    }

    /// Run a retention sweep immediately.
    #[must_use]
    pub fn retain() -> bool {
        let cfg = match ConfigOps::log_config() {
            Ok(cfg) => cfg,
            Err(err) => {
                log!(Topic::Memory, Warn, "log retention skipped: {err}");
                return false;
            }
        };
        let now = IcOps::now_secs();
        let params = policy::log::retention_params(
            policy::log::LogRetentionPolicyInput {
                max_entries: cfg.max_entries,
                max_entry_bytes: cfg.max_entry_bytes,
                max_age_secs: cfg.max_age_secs,
            },
            now,
        );

        match LogOps::apply_retention(params.cutoff, params.max_entries, params.max_entry_bytes) {
            Ok(summary) => {
                let dropped = summary.dropped_total();
                if dropped > 0 {
                    log!(
                        Topic::Memory,
                        Info,
                        "log retention: dropped={}, before={}, retained={}",
                        dropped,
                        summary.before,
                        summary.retained
                    );
                }
                true
            }
            Err(err) => {
                log!(Topic::Memory, Warn, "log retention failed: {err}");
                false
            }
        }
    }
}