Skip to main content

systemprompt_cli/commands/analytics/
overview.rs

1//! Dashboard overview rolling up every analytics domain into one snapshot.
2//!
3//! [`OverviewArgs`] selects the time range; [`OverviewOutput`] aggregates the
4//! per-domain metric cards (conversations, agents, requests, tools, sessions,
5//! costs), comparing each against the immediately preceding period of equal
6//! length to derive change percentages. Supports CSV export of the rolled-up
7//! row.
8
9use anyhow::Result;
10use chrono::{DateTime, Utc};
11use clap::Args;
12use schemars::JsonSchema;
13use serde::{Deserialize, Serialize};
14use std::path::PathBuf;
15use systemprompt_analytics::OverviewAnalyticsRepository;
16use systemprompt_logging::CliService;
17use systemprompt_runtime::DatabaseContext;
18
19use super::shared::{CsvBuilder, parse_time_range, resolve_export_path};
20use crate::CliConfig;
21use crate::shared::CommandOutput;
22
23#[derive(Debug, Args)]
24pub struct OverviewArgs {
25    #[arg(
26        long,
27        alias = "from",
28        default_value = "24h",
29        help = "Time range (e.g., '1h', '24h', '7d')"
30    )]
31    pub since: Option<String>,
32
33    #[arg(long, alias = "to", help = "End time for range")]
34    pub until: Option<String>,
35
36    #[arg(long, help = "Export results to CSV file")]
37    pub export: Option<PathBuf>,
38}
39
40#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
41pub struct OverviewOutput {
42    pub period: String,
43    pub conversations: ConversationMetrics,
44    pub agents: AgentMetrics,
45    pub requests: RequestMetrics,
46    pub tools: ToolMetrics,
47    pub sessions: SessionMetrics,
48    pub costs: CostMetrics,
49}
50
51#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
52pub struct ConversationMetrics {
53    pub total: i64,
54    pub change_percent: Option<f64>,
55}
56
57#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
58pub struct AgentMetrics {
59    pub active_count: i64,
60    pub total_tasks: i64,
61    pub success_rate: f64,
62}
63
64#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
65pub struct RequestMetrics {
66    pub total: i64,
67    pub total_tokens: i64,
68    pub avg_latency_ms: i64,
69}
70
71#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
72pub struct ToolMetrics {
73    pub total_executions: i64,
74    pub success_rate: f64,
75}
76
77#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
78pub struct SessionMetrics {
79    #[serde(rename = "currently_active")]
80    pub active: i64,
81    #[serde(rename = "created_in_period")]
82    pub total_today: i64,
83}
84
85#[derive(Debug, Clone, Copy, Serialize, Deserialize, JsonSchema)]
86pub struct CostMetrics {
87    pub total_cost_microdollars: i64,
88    pub change_percent: Option<f64>,
89}
90
91pub async fn execute_with_pool(
92    args: OverviewArgs,
93    db_ctx: &DatabaseContext,
94    _config: &CliConfig,
95) -> Result<CommandOutput> {
96    let repo = OverviewAnalyticsRepository::new(db_ctx.db_pool())?;
97    execute_internal(args, &repo).await
98}
99
100async fn execute_internal(
101    args: OverviewArgs,
102    repo: &OverviewAnalyticsRepository,
103) -> Result<CommandOutput> {
104    let (start, end) = parse_time_range(args.since.as_ref(), args.until.as_ref())?;
105    let output = fetch_overview_data(repo, start, end).await?;
106
107    if let Some(ref path) = args.export {
108        let resolved_path = resolve_export_path(path)?;
109        export_overview_csv(&output, &resolved_path)?;
110        CliService::success(&format!("Exported to {}", resolved_path.display()));
111        return Ok(CommandOutput::card_value("Analytics Overview", &output).with_skip_render());
112    }
113
114    Ok(CommandOutput::card_value("Analytics Overview", &output))
115}
116
117async fn fetch_overview_data(
118    repo: &OverviewAnalyticsRepository,
119    start: DateTime<Utc>,
120    end: DateTime<Utc>,
121) -> Result<OverviewOutput> {
122    let period_duration = end - start;
123    let prev_start = start - period_duration;
124
125    let current_conversations = repo.get_conversation_count(start, end).await?;
126    let prev_conversations = repo.get_conversation_count(prev_start, start).await?;
127
128    let conversations = ConversationMetrics {
129        total: current_conversations,
130        change_percent: calculate_change(current_conversations, prev_conversations),
131    };
132
133    let agent_metrics = repo.get_agent_metrics(start, end).await?;
134    let success_rate = if agent_metrics.total_tasks > 0 {
135        (agent_metrics.completed_tasks as f64 / agent_metrics.total_tasks as f64) * 100.0
136    } else {
137        0.0
138    };
139
140    let agents = AgentMetrics {
141        active_count: agent_metrics.active_agents,
142        total_tasks: agent_metrics.total_tasks,
143        success_rate,
144    };
145
146    let request_metrics = repo.get_request_metrics(start, end).await?;
147    let requests = RequestMetrics {
148        total: request_metrics.total,
149        total_tokens: request_metrics.total_tokens.unwrap_or(0),
150        avg_latency_ms: request_metrics.avg_latency.map_or(0, |v| v as i64),
151    };
152
153    let tool_metrics = repo.get_tool_metrics(start, end).await?;
154    let tool_success_rate = if tool_metrics.total > 0 {
155        (tool_metrics.successful as f64 / tool_metrics.total as f64) * 100.0
156    } else {
157        0.0
158    };
159
160    let tools = ToolMetrics {
161        total_executions: tool_metrics.total,
162        success_rate: tool_success_rate,
163    };
164
165    let active_sessions = repo.get_active_session_count(start).await?;
166    let total_sessions = repo.get_total_session_count(start, end).await?;
167
168    let sessions = SessionMetrics {
169        active: active_sessions,
170        total_today: total_sessions,
171    };
172
173    let current_cost = repo.get_cost(start, end).await?;
174    let prev_cost = repo.get_cost(prev_start, start).await?;
175
176    let costs = CostMetrics {
177        total_cost_microdollars: current_cost.cost.unwrap_or(0),
178        change_percent: calculate_change(
179            current_cost.cost.unwrap_or(0),
180            prev_cost.cost.unwrap_or(0),
181        ),
182    };
183
184    Ok(OverviewOutput {
185        period: format_period(start, end),
186        conversations,
187        agents,
188        requests,
189        tools,
190        sessions,
191        costs,
192    })
193}
194
195fn calculate_change(current: i64, previous: i64) -> Option<f64> {
196    (previous != 0).then(|| ((current - previous) as f64 / previous as f64) * 100.0)
197}
198
199fn format_period(start: DateTime<Utc>, end: DateTime<Utc>) -> String {
200    format!(
201        "{} to {}",
202        start.format("%Y-%m-%d %H:%M"),
203        end.format("%Y-%m-%d %H:%M")
204    )
205}
206
207fn export_overview_csv(output: &OverviewOutput, path: &std::path::Path) -> Result<()> {
208    let mut csv = CsvBuilder::new().headers(vec![
209        "period",
210        "conversations_total",
211        "conversations_change_pct",
212        "agents_active",
213        "agents_tasks",
214        "agents_success_rate",
215        "requests_total",
216        "requests_tokens",
217        "requests_avg_latency_ms",
218        "tools_executions",
219        "tools_success_rate",
220        "sessions_currently_active",
221        "sessions_created_in_period",
222        "costs_microdollars",
223        "costs_change_pct",
224    ]);
225
226    csv.add_row(vec![
227        output.period.clone(),
228        output.conversations.total.to_string(),
229        output
230            .conversations
231            .change_percent
232            .map_or(String::new(), |v| format!("{:.2}", v)),
233        output.agents.active_count.to_string(),
234        output.agents.total_tasks.to_string(),
235        format!("{:.2}", output.agents.success_rate),
236        output.requests.total.to_string(),
237        output.requests.total_tokens.to_string(),
238        output.requests.avg_latency_ms.to_string(),
239        output.tools.total_executions.to_string(),
240        format!("{:.2}", output.tools.success_rate),
241        output.sessions.active.to_string(),
242        output.sessions.total_today.to_string(),
243        output.costs.total_cost_microdollars.to_string(),
244        output
245            .costs
246            .change_percent
247            .map_or(String::new(), |v| format!("{:.2}", v)),
248    ]);
249
250    csv.write_to_file(path)
251}