vtcode_config/
debug.rs

1//! Debug and tracing configuration
2
3use serde::{Deserialize, Serialize};
4use std::path::PathBuf;
5
6/// Trace level for structured logging
7#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
8#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
9#[serde(rename_all = "lowercase")]
10#[derive(Default)]
11pub enum TraceLevel {
12    Error,
13    Warn,
14    #[default]
15    Info,
16    Debug,
17    Trace,
18}
19
20impl TraceLevel {
21    pub fn as_str(self) -> &'static str {
22        match self {
23            Self::Error => "error",
24            Self::Warn => "warn",
25            Self::Info => "info",
26            Self::Debug => "debug",
27            Self::Trace => "trace",
28        }
29    }
30
31    pub fn parse(value: &str) -> Option<Self> {
32        match value.trim().to_lowercase().as_str() {
33            "error" => Some(Self::Error),
34            "warn" => Some(Self::Warn),
35            "info" => Some(Self::Info),
36            "debug" => Some(Self::Debug),
37            "trace" => Some(Self::Trace),
38            _ => None,
39        }
40    }
41}
42
43impl std::fmt::Display for TraceLevel {
44    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
45        f.write_str(self.as_str())
46    }
47}
48
49impl<'de> serde::Deserialize<'de> for TraceLevel {
50    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
51    where
52        D: serde::Deserializer<'de>,
53    {
54        let raw = String::deserialize(deserializer)?;
55        if let Some(parsed) = Self::parse(&raw) {
56            Ok(parsed)
57        } else {
58            Ok(Self::default())
59        }
60    }
61}
62
63/// Debug and tracing configuration
64#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
65#[derive(Debug, Clone, Deserialize, Serialize)]
66pub struct DebugConfig {
67    /// Enable structured logging for development and troubleshooting
68    #[serde(default)]
69    pub enable_tracing: bool,
70
71    /// Trace level (error, warn, info, debug, trace)
72    #[serde(default)]
73    pub trace_level: TraceLevel,
74
75    /// List of tracing targets to enable
76    /// Examples: "vtcode_core::agent", "vtcode_core::tools", "vtcode::*"
77    #[serde(default)]
78    pub trace_targets: Vec<String>,
79
80    /// Directory for debug logs
81    #[serde(default)]
82    pub debug_log_dir: Option<String>,
83
84    /// Maximum size of debug logs before rotating (in MB)
85    #[serde(default = "default_max_debug_log_size_mb")]
86    pub max_debug_log_size_mb: u64,
87
88    /// Maximum age of debug logs to keep (in days)
89    #[serde(default = "default_max_debug_log_age_days")]
90    pub max_debug_log_age_days: u32,
91}
92
93fn default_max_debug_log_size_mb() -> u64 {
94    50
95}
96
97fn default_max_debug_log_age_days() -> u32 {
98    7
99}
100
101impl Default for DebugConfig {
102    fn default() -> Self {
103        Self {
104            enable_tracing: false,
105            trace_level: TraceLevel::Info,
106            trace_targets: Vec::new(),
107            debug_log_dir: None,
108            max_debug_log_size_mb: 50,
109            max_debug_log_age_days: 7,
110        }
111    }
112}
113
114impl DebugConfig {
115    /// Get the debug log directory, expanding ~ to home directory
116    pub fn debug_log_path(&self) -> PathBuf {
117        self.debug_log_dir
118            .as_ref()
119            .and_then(|dir| {
120                if dir.starts_with("~") {
121                    dirs::home_dir()
122                        .map(|home| home.join(dir.trim_start_matches('~').trim_start_matches('/')))
123                } else {
124                    Some(PathBuf::from(dir))
125                }
126            })
127            .unwrap_or_else(|| {
128                dirs::home_dir()
129                    .map(|home| home.join(".vtcode/debug"))
130                    .unwrap_or_else(|| PathBuf::from(".vtcode/debug"))
131            })
132    }
133}
134
135#[cfg(test)]
136mod tests {
137    use super::*;
138
139    #[test]
140    fn test_trace_level_parsing() {
141        assert_eq!(TraceLevel::parse("error"), Some(TraceLevel::Error));
142        assert_eq!(TraceLevel::parse("WARN"), Some(TraceLevel::Warn));
143        assert_eq!(TraceLevel::parse("info"), Some(TraceLevel::Info));
144        assert_eq!(TraceLevel::parse("DEBUG"), Some(TraceLevel::Debug));
145        assert_eq!(TraceLevel::parse("trace"), Some(TraceLevel::Trace));
146        assert_eq!(TraceLevel::parse("invalid"), None);
147    }
148
149    #[test]
150    fn test_debug_config_default() {
151        let cfg = DebugConfig::default();
152        assert!(!cfg.enable_tracing);
153        assert_eq!(cfg.trace_level, TraceLevel::Info);
154        assert!(cfg.trace_targets.is_empty());
155        assert_eq!(cfg.max_debug_log_size_mb, 50);
156        assert_eq!(cfg.max_debug_log_age_days, 7);
157    }
158}