pitchfork_cli/log_store/
mod.rs

1use crate::Result;
2use crate::daemon_id::DaemonId;
3use chrono::{DateTime, Local};
4
5/// A single log entry.
6#[derive(Debug, Clone)]
7pub struct LogEntry {
8    pub id: i64,
9    pub daemon_id: String,
10    pub timestamp: DateTime<Local>,
11    pub message: String,
12}
13
14/// Options for querying logs.
15#[derive(Debug, Clone, Default)]
16pub struct LogQuery {
17    pub daemon_ids: Vec<String>,
18    pub from: Option<DateTime<Local>>,
19    pub to: Option<DateTime<Local>>,
20    pub limit: Option<usize>,
21    pub order_desc: bool,
22    pub after_id: Option<i64>,
23}
24
25/// Parsed retention policy.
26#[derive(Debug, Clone, Copy)]
27pub struct RetentionPolicy {
28    /// Maximum age of entries to keep.
29    pub age: Option<chrono::Duration>,
30    /// Maximum number of entries to keep.
31    pub count: Option<u64>,
32}
33
34impl RetentionPolicy {
35    #[allow(dead_code)]
36    pub fn is_none(&self) -> bool {
37        self.age.is_none() && self.count.is_none()
38    }
39}
40
41/// Hook invoked before log entries are pruned by retention.
42#[derive(Debug, Clone)]
43pub struct ArchiveHook {
44    /// Shell command to run. It should read JSONL from stdin.
45    pub command: String,
46    /// Maximum number of log entries to pass to a single hook invocation.
47    pub batch_size: usize,
48}
49
50impl ArchiveHook {
51    /// Returns true if the hook is configured with a non-empty command.
52    pub fn is_enabled(&self) -> bool {
53        !self.command.trim().is_empty()
54    }
55}
56
57/// Unified interface for log storage and retrieval.
58pub trait LogStore: Send + Sync {
59    /// Append a single log line.
60    fn append(&self, daemon_id: &DaemonId, message: &str) -> Result<()>;
61
62    /// Query logs according to the given options.
63    fn query(&self, opts: &LogQuery) -> Result<Vec<LogEntry>>;
64
65    /// Read new log entries for a daemon.
66    /// When `after_id` is Some(id), returns only entries with row id > id.
67    /// When `after_id` is None, returns all entries for the daemon.
68    fn tail(&self, daemon_id: &DaemonId, after_id: Option<i64>) -> Result<Vec<LogEntry>>;
69
70    /// Clear all logs for the given daemon(s).
71    fn clear(&self, daemon_ids: &[DaemonId]) -> Result<()>;
72
73    /// Apply a retention policy (age-based and/or count-based pruning).
74    ///
75    /// By default this applies to all daemons; `excluded_daemon_ids` can be
76    /// used to skip daemons that have their own per-daemon overrides, so the
77    /// global policy does not accidentally prune entries those daemons intend
78    /// to keep.
79    fn apply_retention(
80        &self,
81        policy: &RetentionPolicy,
82        excluded_daemon_ids: &[DaemonId],
83        archive_hook: Option<&ArchiveHook>,
84    ) -> Result<u64> {
85        let _ = (policy, excluded_daemon_ids, archive_hook);
86        Ok(0)
87    }
88
89    /// Apply a retention policy to a specific daemon's logs.
90    fn apply_retention_for_daemon(
91        &self,
92        daemon_id: &DaemonId,
93        policy: &RetentionPolicy,
94        archive_hook: Option<&ArchiveHook>,
95    ) -> Result<u64> {
96        let _ = (daemon_id, policy, archive_hook);
97        Ok(0)
98    }
99
100    /// List all daemon IDs that have log entries.
101    fn list_daemon_ids(&self) -> Result<Vec<String>>;
102
103    /// Return the generation number for the daemon's last clear operation.
104    /// Each call to `clear` bumps the generation, so SSE streams can detect
105    /// when logs have been wiped and refresh their display.
106    fn last_clear_generation(&self, daemon_id: &DaemonId) -> Result<Option<u64>> {
107        let _ = daemon_id;
108        Ok(None)
109    }
110}
111
112pub mod sqlite;
pitchfork_cli/log_store/mod.rs

pitchfork_cli/log_store/
mod.rs
