zeptoclaw 0.9.0

Ultra-lightweight personal AI assistant
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
//! Telemetry exporter for MetricsCollector.
//!
//! Renders session metrics in Prometheus text exposition format or JSON.
//! This module provides only rendering functions — no HTTP server or
//! transport logic.

use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

use super::metrics::MetricsCollector;

// ---------------------------------------------------------------------------
// Configuration
// ---------------------------------------------------------------------------

/// Telemetry output format.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum TelemetryFormat {
    #[default]
    Prometheus,
    Json,
}

/// Telemetry configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct TelemetryConfig {
    /// Whether telemetry export is enabled.
    pub enabled: bool,
    /// Output format (prometheus or json).
    pub format: TelemetryFormat,
    /// HTTP endpoint path for serving metrics.
    pub endpoint: String,
}

impl Default for TelemetryConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            format: TelemetryFormat::default(),
            endpoint: "/metrics".to_string(),
        }
    }
}

// ---------------------------------------------------------------------------
// Renderers
// ---------------------------------------------------------------------------

/// Dispatches to the correct renderer based on the configured format.
pub fn render(collector: &MetricsCollector, format: &TelemetryFormat) -> String {
    match format {
        TelemetryFormat::Prometheus => render_prometheus(collector),
        TelemetryFormat::Json => render_json(collector),
    }
}

/// Renders all metrics in Prometheus text exposition format.
///
/// Metric families emitted:
/// - `zeptoclaw_tool_calls_total` (counter)
/// - `zeptoclaw_tool_errors_total` (counter)
/// - `zeptoclaw_tool_duration_seconds_sum` (counter)
/// - `zeptoclaw_tool_duration_seconds_min` (gauge)
/// - `zeptoclaw_tool_duration_seconds_max` (gauge)
/// - `zeptoclaw_tokens_input_total` (counter)
/// - `zeptoclaw_tokens_output_total` (counter)
/// - `zeptoclaw_session_duration_seconds` (gauge)
pub fn render_prometheus(collector: &MetricsCollector) -> String {
    let mut out = String::new();

    // Collect per-tool metrics into a BTreeMap for deterministic ordering.
    let tools: BTreeMap<_, _> = collector.all_tool_metrics().into_iter().collect();

    // --- tool calls total ---
    out.push_str("# HELP zeptoclaw_tool_calls_total Total number of tool calls.\n");
    out.push_str("# TYPE zeptoclaw_tool_calls_total counter\n");
    for (name, m) in &tools {
        out.push_str(&format!(
            "zeptoclaw_tool_calls_total{{tool=\"{}\"}} {}\n",
            name, m.call_count,
        ));
    }

    // --- tool errors total ---
    out.push_str("# HELP zeptoclaw_tool_errors_total Total number of tool call errors.\n");
    out.push_str("# TYPE zeptoclaw_tool_errors_total counter\n");
    for (name, m) in &tools {
        out.push_str(&format!(
            "zeptoclaw_tool_errors_total{{tool=\"{}\"}} {}\n",
            name, m.error_count,
        ));
    }

    // --- tool duration sum ---
    out.push_str(
        "# HELP zeptoclaw_tool_duration_seconds_sum Cumulative tool call duration in seconds.\n",
    );
    out.push_str("# TYPE zeptoclaw_tool_duration_seconds_sum counter\n");
    for (name, m) in &tools {
        out.push_str(&format!(
            "zeptoclaw_tool_duration_seconds_sum{{tool=\"{}\"}} {:.6}\n",
            name,
            m.total_duration.as_secs_f64(),
        ));
    }

    // --- tool duration min ---
    out.push_str(
        "# HELP zeptoclaw_tool_duration_seconds_min Minimum observed tool call duration in seconds.\n",
    );
    out.push_str("# TYPE zeptoclaw_tool_duration_seconds_min gauge\n");
    for (name, m) in &tools {
        let val = m.min_duration.map_or(0.0, |d| d.as_secs_f64());
        out.push_str(&format!(
            "zeptoclaw_tool_duration_seconds_min{{tool=\"{}\"}} {:.6}\n",
            name, val,
        ));
    }

    // --- tool duration max ---
    out.push_str(
        "# HELP zeptoclaw_tool_duration_seconds_max Maximum observed tool call duration in seconds.\n",
    );
    out.push_str("# TYPE zeptoclaw_tool_duration_seconds_max gauge\n");
    for (name, m) in &tools {
        let val = m.max_duration.map_or(0.0, |d| d.as_secs_f64());
        out.push_str(&format!(
            "zeptoclaw_tool_duration_seconds_max{{tool=\"{}\"}} {:.6}\n",
            name, val,
        ));
    }

    // --- tokens ---
    let (tokens_in, tokens_out) = collector.total_tokens();

    out.push_str("# HELP zeptoclaw_tokens_input_total Total input tokens consumed.\n");
    out.push_str("# TYPE zeptoclaw_tokens_input_total counter\n");
    out.push_str(&format!("zeptoclaw_tokens_input_total {}\n", tokens_in));

    out.push_str("# HELP zeptoclaw_tokens_output_total Total output tokens produced.\n");
    out.push_str("# TYPE zeptoclaw_tokens_output_total counter\n");
    out.push_str(&format!("zeptoclaw_tokens_output_total {}\n", tokens_out));

    // --- session duration ---
    out.push_str("# HELP zeptoclaw_session_duration_seconds Session uptime in seconds.\n");
    out.push_str("# TYPE zeptoclaw_session_duration_seconds gauge\n");
    out.push_str(&format!(
        "zeptoclaw_session_duration_seconds {:.6}\n",
        collector.session_duration().as_secs_f64(),
    ));

    out
}

/// Renders all metrics as a JSON string.
///
/// The output structure:
/// ```json
/// {
///   "tools": {
///     "shell": {
///       "call_count": 5,
///       "error_count": 1,
///       "total_duration_seconds": 1.234,
///       "min_duration_seconds": 0.1,
///       "max_duration_seconds": 0.5
///     }
///   },
///   "tokens_input_total": 1500,
///   "tokens_output_total": 800,
///   "session_duration_seconds": 45.0
/// }
/// ```
pub fn render_json(collector: &MetricsCollector) -> String {
    let tools_raw = collector.all_tool_metrics();
    // Use BTreeMap for deterministic key order.
    let mut tools_json: BTreeMap<String, serde_json::Value> = BTreeMap::new();

    for (name, m) in &tools_raw {
        tools_json.insert(
            name.clone(),
            serde_json::json!({
                "call_count": m.call_count,
                "error_count": m.error_count,
                "total_duration_seconds": m.total_duration.as_secs_f64(),
                "min_duration_seconds": m.min_duration.map(|d| d.as_secs_f64()),
                "max_duration_seconds": m.max_duration.map(|d| d.as_secs_f64()),
            }),
        );
    }

    let (tokens_in, tokens_out) = collector.total_tokens();

    let root = serde_json::json!({
        "tools": tools_json,
        "tokens_input_total": tokens_in,
        "tokens_output_total": tokens_out,
        "session_duration_seconds": collector.session_duration().as_secs_f64(),
    });

    serde_json::to_string_pretty(&root).expect("metrics JSON serialization should never fail")
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;

    // -- TelemetryConfig defaults --

    #[test]
    fn test_telemetry_config_defaults() {
        let config = TelemetryConfig::default();
        assert!(!config.enabled);
        assert_eq!(config.format, TelemetryFormat::Prometheus);
        assert_eq!(config.endpoint, "/metrics");
    }

    // -- TelemetryFormat default --

    #[test]
    fn test_telemetry_format_default_is_prometheus() {
        assert_eq!(TelemetryFormat::default(), TelemetryFormat::Prometheus);
    }

    // -- Serde roundtrip for TelemetryConfig --

    #[test]
    fn test_telemetry_config_serde_roundtrip() {
        let config = TelemetryConfig {
            enabled: true,
            format: TelemetryFormat::Json,
            endpoint: "/custom-metrics".to_string(),
        };
        let json = serde_json::to_string(&config).unwrap();
        let restored: TelemetryConfig = serde_json::from_str(&json).unwrap();

        assert_eq!(restored.enabled, config.enabled);
        assert_eq!(restored.format, config.format);
        assert_eq!(restored.endpoint, config.endpoint);
    }

    #[test]
    fn test_telemetry_config_serde_uses_defaults_for_missing_fields() {
        let json = "{}";
        let config: TelemetryConfig = serde_json::from_str(json).unwrap();
        assert!(!config.enabled);
        assert_eq!(config.format, TelemetryFormat::Prometheus);
        assert_eq!(config.endpoint, "/metrics");
    }

    // -- Serde variants for TelemetryFormat --

    #[test]
    fn test_telemetry_format_serde_prometheus() {
        let json = serde_json::to_string(&TelemetryFormat::Prometheus).unwrap();
        assert_eq!(json, "\"prometheus\"");
        let restored: TelemetryFormat = serde_json::from_str(&json).unwrap();
        assert_eq!(restored, TelemetryFormat::Prometheus);
    }

    #[test]
    fn test_telemetry_format_serde_json() {
        let json = serde_json::to_string(&TelemetryFormat::Json).unwrap();
        assert_eq!(json, "\"json\"");
        let restored: TelemetryFormat = serde_json::from_str(&json).unwrap();
        assert_eq!(restored, TelemetryFormat::Json);
    }

    // -- render_prometheus with empty metrics --

    #[test]
    fn test_render_prometheus_empty_metrics() {
        let collector = MetricsCollector::new();
        let output = render_prometheus(&collector);

        // Should still contain HELP/TYPE headers for token and session metrics.
        assert!(output.contains("# HELP zeptoclaw_tokens_input_total"));
        assert!(output.contains("# TYPE zeptoclaw_tokens_input_total counter"));
        assert!(output.contains("zeptoclaw_tokens_input_total 0"));
        assert!(output.contains("zeptoclaw_tokens_output_total 0"));
        assert!(output.contains("# HELP zeptoclaw_session_duration_seconds"));
        assert!(output.contains("zeptoclaw_session_duration_seconds"));

        // No tool-level data lines (only HELP/TYPE headers for tool metrics).
        assert!(!output.contains("tool=\""));
    }

    // -- render_prometheus with populated metrics --

    #[test]
    fn test_render_prometheus_populated_metrics() {
        let collector = MetricsCollector::new();
        collector.record_tool_call("shell", Duration::from_millis(100), true);
        collector.record_tool_call("shell", Duration::from_millis(300), false);
        collector.record_tool_call("read_file", Duration::from_millis(5), true);
        collector.record_tokens(1500, 800);

        let output = render_prometheus(&collector);

        // Tool call counts.
        assert!(output.contains("zeptoclaw_tool_calls_total{tool=\"shell\"} 2"));
        assert!(output.contains("zeptoclaw_tool_calls_total{tool=\"read_file\"} 1"));

        // Error counts.
        assert!(output.contains("zeptoclaw_tool_errors_total{tool=\"shell\"} 1"));
        assert!(output.contains("zeptoclaw_tool_errors_total{tool=\"read_file\"} 0"));

        // Tokens.
        assert!(output.contains("zeptoclaw_tokens_input_total 1500"));
        assert!(output.contains("zeptoclaw_tokens_output_total 800"));
    }

    // -- render_prometheus contains expected metric names and labels --

    #[test]
    fn test_render_prometheus_contains_expected_metric_families() {
        let collector = MetricsCollector::new();
        collector.record_tool_call("web_fetch", Duration::from_millis(200), true);

        let output = render_prometheus(&collector);

        let expected_families = [
            "zeptoclaw_tool_calls_total",
            "zeptoclaw_tool_errors_total",
            "zeptoclaw_tool_duration_seconds_sum",
            "zeptoclaw_tool_duration_seconds_min",
            "zeptoclaw_tool_duration_seconds_max",
            "zeptoclaw_tokens_input_total",
            "zeptoclaw_tokens_output_total",
            "zeptoclaw_session_duration_seconds",
        ];

        for family in &expected_families {
            assert!(
                output.contains(&format!("# HELP {}", family)),
                "Missing HELP for {}",
                family,
            );
            assert!(
                output.contains(&format!("# TYPE {}", family)),
                "Missing TYPE for {}",
                family,
            );
        }

        // Labels present.
        assert!(output.contains("tool=\"web_fetch\""));
    }

    // -- render_json with empty metrics --

    #[test]
    fn test_render_json_empty_metrics() {
        let collector = MetricsCollector::new();
        let output = render_json(&collector);
        let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();

        assert_eq!(parsed["tools"], serde_json::json!({}));
        assert_eq!(parsed["tokens_input_total"], 0);
        assert_eq!(parsed["tokens_output_total"], 0);
        assert!(parsed["session_duration_seconds"].as_f64().unwrap() >= 0.0);
    }

    // -- render_json with populated metrics --

    #[test]
    fn test_render_json_populated_metrics() {
        let collector = MetricsCollector::new();
        collector.record_tool_call("shell", Duration::from_millis(100), true);
        collector.record_tool_call("shell", Duration::from_millis(300), false);
        collector.record_tokens(500, 200);

        let output = render_json(&collector);
        let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();

        let shell = &parsed["tools"]["shell"];
        assert_eq!(shell["call_count"], 2);
        assert_eq!(shell["error_count"], 1);
        assert!(shell["total_duration_seconds"].as_f64().unwrap() > 0.0);
        assert!(shell["min_duration_seconds"].as_f64().unwrap() > 0.0);
        assert!(shell["max_duration_seconds"].as_f64().unwrap() > 0.0);

        assert_eq!(parsed["tokens_input_total"], 500);
        assert_eq!(parsed["tokens_output_total"], 200);
    }

    // -- render dispatches correctly --

    #[test]
    fn test_render_dispatches_prometheus() {
        let collector = MetricsCollector::new();
        collector.record_tool_call("test_tool", Duration::from_millis(50), true);

        let output = render(&collector, &TelemetryFormat::Prometheus);
        // Prometheus format uses HELP/TYPE comments.
        assert!(output.contains("# HELP"));
        assert!(output.contains("# TYPE"));
        assert!(output.contains("tool=\"test_tool\""));
    }

    #[test]
    fn test_render_dispatches_json() {
        let collector = MetricsCollector::new();
        collector.record_tool_call("test_tool", Duration::from_millis(50), true);

        let output = render(&collector, &TelemetryFormat::Json);
        // JSON format parses as valid JSON.
        let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();
        assert!(parsed["tools"]["test_tool"].is_object());
    }
}