scouty 0.2.0

Log parsing, filtering, and analysis library
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
#[cfg(test)]
mod tests {
    use crate::parser::sairedis_parser::*;
    use crate::record::LogRecord;
    use std::sync::Arc;

    fn parse(parser: &SairedisParser, line: &str) -> Option<LogRecord> {
        let source: Arc<str> = Arc::from("test");
        let loader_id: Arc<str> = Arc::from("test");
        parser.parse_shared(line, &source, &loader_id, 0)
    }

    #[test]
    fn test_create_with_oid() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-18.06:38:35.610696|c|SAI_OBJECT_TYPE_HOSTIF:oid:0xd00000000137b|SAI_HOSTIF_ATTR_TYPE=SAI_HOSTIF_TYPE_NETDEV|SAI_HOSTIF_ATTR_OBJ_ID=oid:0x1000000000063|SAI_HOSTIF_ATTR_NAME=Ethernet").unwrap();
        assert_eq!(r.function.as_deref(), Some("Create"));
        assert_eq!(r.component_name.as_deref(), Some("SAI_OBJECT_TYPE_HOSTIF"));
        assert_eq!(r.context.as_deref(), Some("oid:0xd00000000137b"));
        assert_eq!(r.message, "SAI_HOSTIF_ATTR_TYPE=SAI_HOSTIF_TYPE_NETDEV|SAI_HOSTIF_ATTR_OBJ_ID=oid:0x1000000000063|SAI_HOSTIF_ATTR_NAME=Ethernet");
        assert_eq!(r.timestamp.to_rfc3339(), "2025-05-18T06:38:35.610696+00:00");
    }

    #[test]
    fn test_create_with_json_context() {
        let p = SairedisParser::new();
        let r = parse(&p, r#"2025-05-18.06:38:34.056792|c|SAI_OBJECT_TYPE_ROUTE_ENTRY:{"dest":"fe80::/10","switch_id":"oid:0x21000000000000","vr":"oid:0x3000000000083"}|SAI_ROUTE_ENTRY_ATTR_PACKET_ACTION=SAI_PACKET_ACTION_FORWARD|SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID=oid:0x1000000000093"#).unwrap();
        assert_eq!(r.function.as_deref(), Some("Create"));
        assert_eq!(
            r.component_name.as_deref(),
            Some("SAI_OBJECT_TYPE_ROUTE_ENTRY")
        );
        assert!(r.context.as_deref().unwrap().contains("fe80::/10"));
        assert!(r.message.contains("SAI_ROUTE_ENTRY_ATTR_PACKET_ACTION"));
    }

    #[test]
    fn test_remove() {
        let p = SairedisParser::new();
        let r = parse(
            &p,
            "2025-05-17.21:58:30.286883|r|SAI_OBJECT_TYPE_VLAN_MEMBER:oid:0x2700000000062e",
        )
        .unwrap();
        assert_eq!(r.function.as_deref(), Some("Remove"));
        assert_eq!(
            r.component_name.as_deref(),
            Some("SAI_OBJECT_TYPE_VLAN_MEMBER")
        );
        assert_eq!(r.context.as_deref(), Some("oid:0x2700000000062e"));
        assert!(r.message.is_empty());
    }

    #[test]
    fn test_set() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:42:03.233241|s|SAI_OBJECT_TYPE_PORT:oid:0x100000000001e|SAI_PORT_ATTR_ADMIN_STATE=true").unwrap();
        assert_eq!(r.function.as_deref(), Some("Set"));
        assert_eq!(r.component_name.as_deref(), Some("SAI_OBJECT_TYPE_PORT"));
        assert_eq!(r.context.as_deref(), Some("oid:0x100000000001e"));
        assert_eq!(r.message, "SAI_PORT_ATTR_ADMIN_STATE=true");
    }

    #[test]
    fn test_get_and_get_response_stateful() {
        let p = SairedisParser::new();

        // Parse 'g' first — saves context
        let g = parse(&p, "2025-05-17.18:49:14.280510|g|SAI_OBJECT_TYPE_PORT:oid:0x1000000000011|SAI_PORT_ATTR_REMOTE_ADVERTISED_SPEED=16:0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0").unwrap();
        assert_eq!(g.function.as_deref(), Some("Get"));
        assert_eq!(g.context.as_deref(), Some("oid:0x1000000000011"));

        // Parse 'G' — should inherit context from last 'g'
        let gr = parse(&p, "2025-05-17.18:49:14.282097|G|SAI_STATUS_SUCCESS|SAI_PORT_ATTR_REMOTE_ADVERTISED_SPEED=0:null").unwrap();
        assert_eq!(gr.function.as_deref(), Some("GetResponse"));
        assert_eq!(gr.context.as_deref(), Some("oid:0x1000000000011")); // stateful!
        assert_eq!(
            gr.message,
            "SAI_STATUS_SUCCESS|SAI_PORT_ATTR_REMOTE_ADVERTISED_SPEED=0:null"
        );
        assert!(gr.component_name.is_none());
    }

    #[test]
    fn test_get_response_without_prior_get() {
        let p = SairedisParser::new();
        let r = parse(
            &p,
            "2025-05-17.18:49:14.282097|G|SAI_STATUS_SUCCESS|attr=val",
        )
        .unwrap();
        assert_eq!(r.function.as_deref(), Some("GetResponse"));
        assert!(r.context.is_none()); // no prior 'g'
    }

    #[test]
    fn test_bulk_create() {
        let p = SairedisParser::new();
        let r = parse(&p, r#"2025-05-17.18:42:03.242891|C|SAI_OBJECT_TYPE_ROUTE_ENTRY||{"dest":"fc00::78/126","switch_id":"oid:0x21000000000000","vr":"oid:0x3000000000083"}|SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID=oid:0x60000000015fe||{"dest":"10.0.0.60/31","switch_id":"oid:0x21000000000000","vr":"oid:0x3000000000083"}|SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID=oid:0x60000000015fe"#).unwrap();
        assert_eq!(r.function.as_deref(), Some("BulkCreate"));
        assert_eq!(
            r.component_name.as_deref(),
            Some("SAI_OBJECT_TYPE_ROUTE_ENTRY")
        );
        assert!(r.context.is_none()); // bulk ops have no single context
        assert!(r.message.contains("||")); // message includes entire detail after type
    }

    #[test]
    fn test_bulk_remove() {
        let p = SairedisParser::new();
        let r = parse(&p, r#"2025-05-17.18:41:58.557700|R|SAI_OBJECT_TYPE_ROUTE_ENTRY||{"dest":"fc00::78/126","switch_id":"oid:0x21000000000000","vr":"oid:0x3000000000083"}||{"dest":"10.0.0.60/31","switch_id":"oid:0x21000000000000","vr":"oid:0x3000000000083"}"#).unwrap();
        assert_eq!(r.function.as_deref(), Some("BulkRemove"));
        assert_eq!(
            r.component_name.as_deref(),
            Some("SAI_OBJECT_TYPE_ROUTE_ENTRY")
        );
        assert!(r.message.contains("||"));
    }

    #[test]
    fn test_query_and_query_response_stateful() {
        let p = SairedisParser::new();

        // Parse 'q' first
        let q = parse(&p, "2025-05-17.18:49:14.501934|q|object_type_get_availability|SAI_OBJECT_TYPE_SWITCH:oid:0x21000000000000|SAI_ROUTE_ENTRY_ATTR_IP_ADDR_FAMILY=SAI_IP_ADDR_FAMILY_IPV4").unwrap();
        assert_eq!(
            q.function.as_deref(),
            Some("Query: object_type_get_availability")
        );
        assert_eq!(q.context.as_deref(), Some("oid:0x21000000000000"));
        assert_eq!(
            q.message,
            "SAI_ROUTE_ENTRY_ATTR_IP_ADDR_FAMILY=SAI_IP_ADDR_FAMILY_IPV4"
        );

        // Parse 'Q' — should inherit context from last 'q'
        let qr = parse(&p, "2025-05-17.18:49:14.502430|Q|object_type_get_availability|SAI_STATUS_NOT_IMPLEMENTED|COUNT=0").unwrap();
        assert_eq!(
            qr.function.as_deref(),
            Some("QueryResponse: object_type_get_availability")
        );
        assert_eq!(qr.context.as_deref(), Some("oid:0x21000000000000")); // stateful!
        assert_eq!(qr.message, "SAI_STATUS_NOT_IMPLEMENTED|COUNT=0");
    }

    #[test]
    fn test_notification() {
        let p = SairedisParser::new();
        let r = parse(&p, r#"2025-05-17.18:41:58.563631|n|port_state_change|[{"port_error_status":"SAI_PORT_ERROR_STATUS_CLEAR","port_id":"oid:0x100000000001e","port_state":"SAI_PORT_OPER_STATUS_DOWN"}]|"#).unwrap();
        assert_eq!(
            r.function.as_deref(),
            Some("Notification: port_state_change")
        );
        assert!(r.message.contains("port_error_status"));
        assert!(!r.message.ends_with('|')); // trailing pipe should be trimmed
    }

    #[test]
    fn test_counter_poll() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:42:03.233241|p|SAI_OBJECT_TYPE_PORT:oid:0x100000000001e|SAI_PORT_ATTR_ADMIN_STATE=true").unwrap();
        assert_eq!(r.function.as_deref(), Some("CounterPoll"));
        assert_eq!(r.component_name.as_deref(), Some("SAI_OBJECT_TYPE_PORT"));
    }

    #[test]
    fn test_unknown_op_code_fallback() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:42:03.233241|x|some random content here").unwrap();
        assert_eq!(r.function.as_deref(), Some("x"));
        assert_eq!(r.message, "some random content here");
        assert!(r.component_name.is_none());
    }

    #[test]
    fn test_auto_detect_sairedis() {
        assert!(looks_like_sairedis(
            "2025-05-18.06:38:35.610696|c|SAI_OBJECT_TYPE_HOSTIF:oid:0x137b"
        ));
        assert!(looks_like_sairedis(
            "2025-05-17.21:58:30.286883|r|SAI_OBJECT_TYPE_VLAN_MEMBER:oid:0x62e"
        ));
        assert!(looks_like_sairedis(
            "2025-05-17.18:49:14.282097|G|SAI_STATUS_SUCCESS"
        ));
    }

    #[test]
    fn test_auto_detect_rejects_swss() {
        // SWSS has multi-char second segment (TABLE_NAME)
        assert!(!looks_like_sairedis(
            "2025-05-17.18:42:03.233241|SWITCH_TABLE:switch|SET|k:v"
        ));
    }

    #[test]
    fn test_auto_detect_rejects_too_short() {
        assert!(!looks_like_sairedis("short"));
        assert!(!looks_like_sairedis(""));
    }

    #[test]
    fn test_create_json_context_with_colons() {
        // JSON context contains ':' characters — parser should handle correctly
        let p = SairedisParser::new();
        let r = parse(&p, r#"2025-05-18.06:38:34.056792|c|SAI_OBJECT_TYPE_ROUTE_ENTRY:{"dest":"fc00::78/126","switch_id":"oid:0x21000000000000"}|SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID=oid:0x60000000015fe"#).unwrap();
        assert_eq!(
            r.component_name.as_deref(),
            Some("SAI_OBJECT_TYPE_ROUTE_ENTRY")
        );
        // Context should be the full JSON string
        assert!(r.context.as_deref().unwrap().starts_with('{'));
        assert!(r.context.as_deref().unwrap().contains("fc00::78/126"));
    }

    #[test]
    fn test_bulk_set_and_bulk_get() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:42:03.242891|S|SAI_OBJECT_TYPE_PORT||oid:0x1|attr=val||oid:0x2|attr=val2").unwrap();
        assert_eq!(r.function.as_deref(), Some("BulkSet"));

        let r = parse(&p, "2025-05-17.18:42:03.242891|B|SAI_OBJECT_TYPE_PORT||oid:0x1|attr=val||oid:0x2|attr=val2").unwrap();
        assert_eq!(r.function.as_deref(), Some("BulkGet"));
    }

    #[test]
    fn test_multiple_get_response_updates_context() {
        let p = SairedisParser::new();

        // First get
        parse(
            &p,
            "2025-05-17.18:49:14.280510|g|SAI_OBJECT_TYPE_PORT:oid:0x1|attr=val",
        )
        .unwrap();

        // First get response — should have context from first get
        let r1 = parse(&p, "2025-05-17.18:49:14.282097|G|SAI_STATUS_SUCCESS").unwrap();
        assert_eq!(r1.context.as_deref(), Some("oid:0x1"));

        // Second get with different context
        parse(
            &p,
            "2025-05-17.18:49:15.280510|g|SAI_OBJECT_TYPE_PORT:oid:0x2|attr=val",
        )
        .unwrap();

        // Second get response — should have NEW context
        let r2 = parse(&p, "2025-05-17.18:49:15.282097|G|SAI_STATUS_FAILURE").unwrap();
        assert_eq!(r2.context.as_deref(), Some("oid:0x2"));
    }

    #[test]
    fn test_timestamp_parsing_various() {
        let p = SairedisParser::new();

        // Short fractional
        let r = parse(
            &p,
            "2025-01-01.00:00:00.1|c|SAI_OBJECT_TYPE_X:oid:0x1|attr=val",
        )
        .unwrap();
        assert_eq!(r.timestamp.timestamp_micros(), 1735689600_100000);

        // Full 6-digit fractional
        let r = parse(
            &p,
            "2025-12-31.23:59:59.999999|c|SAI_OBJECT_TYPE_X:oid:0x1|attr=val",
        )
        .unwrap();
        assert_eq!(r.timestamp.timestamp_micros(), 1767225599_999999);
    }

    // ── LogLevel mapping tests ──────────────────────────────────────────

    #[test]
    fn test_notification_has_notice_level() {
        let p = SairedisParser::new();
        let r = parse(
            &p,
            r#"2025-05-17.18:41:58.563631|n|port_state_change|[{"port_id":"oid:0x1"}]|"#,
        )
        .unwrap();
        assert_eq!(r.level, Some(crate::record::LogLevel::Notice));
    }

    #[test]
    fn test_create_has_info_level() {
        let p = SairedisParser::new();
        let r = parse(
            &p,
            "2025-05-17.18:42:03.233241|c|SAI_OBJECT_TYPE_PORT:oid:0x1|attr=val",
        )
        .unwrap();
        assert_eq!(r.level, Some(crate::record::LogLevel::Info));
    }

    #[test]
    fn test_get_response_has_info_level() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:49:14.282097|G|SAI_STATUS_SUCCESS").unwrap();
        assert_eq!(r.level, Some(crate::record::LogLevel::Info));
    }

    #[test]
    fn test_unknown_op_has_info_level() {
        let p = SairedisParser::new();
        let r = parse(&p, "2025-05-17.18:42:03.233241|x|some content").unwrap();
        assert_eq!(r.level, Some(crate::record::LogLevel::Info));
    }

    #[test]
    fn test_performance_parse_rate() {
        let lines: Vec<String> = (0..10_000)
            .map(|i| {
                format!(
                    "2025-05-18.06:38:{:02}.{:06}|c|SAI_OBJECT_TYPE_HOSTIF:oid:0x{:08x}|SAI_HOSTIF_ATTR_TYPE=SAI_HOSTIF_TYPE_NETDEV",
                    i % 60, i % 1_000_000, i
                )
            })
            .collect();

        let p = SairedisParser::new();
        let source: Arc<str> = Arc::from("bench");
        let loader_id: Arc<str> = Arc::from("bench");
        let start = std::time::Instant::now();
        let mut count = 0;
        for (i, line) in lines.iter().enumerate() {
            if p.parse_shared(line, &source, &loader_id, i as u64)
                .is_some()
            {
                count += 1;
            }
        }
        let elapsed = start.elapsed();
        let rate = count as f64 / elapsed.as_secs_f64();
        eprintln!(
            "Sairedis parse: {} rec in {:?} = {:.1}M rec/sec",
            count,
            elapsed,
            rate / 1e6
        );
        assert_eq!(count, 10_000);
        // Only enforce performance threshold in non-debug builds to avoid flaky tests.
        if !cfg!(debug_assertions) {
            assert!(rate > 500_000.0, "Too slow: {:.0} rec/sec", rate);
        }
    }

    #[test]
    fn test_expanded_create_op() {
        let p = SairedisParser::new();
        let r = p
            .parse(
                "2025-01-15.10:30:45.123456|c|SAI_OBJECT_TYPE_ROUTE_ENTRY:oid:0x1234|SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID=oid:0x5678",
                "test",
                "loader",
                1,
            )
            .unwrap();
        let expanded = r.expanded.as_ref().unwrap();
        assert_eq!(expanded[0].label, "Operation");
        assert_eq!(
            expanded[0].value,
            crate::record::ExpandedValue::Text("Create".to_string())
        );
        assert_eq!(expanded[1].label, "Object Type");
        assert_eq!(
            expanded[1].value,
            crate::record::ExpandedValue::Text("SAI_OBJECT_TYPE_ROUTE_ENTRY".to_string())
        );
        assert_eq!(expanded[2].label, "OID");
        assert_eq!(
            expanded[2].value,
            crate::record::ExpandedValue::Text("oid:0x1234".to_string())
        );
        assert_eq!(expanded[3].label, "Attributes");
        if let crate::record::ExpandedValue::KeyValue(pairs) = &expanded[3].value {
            assert_eq!(pairs[0].0, "SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID");
            assert_eq!(
                pairs[0].1,
                crate::record::ExpandedValue::Text("oid:0x5678".to_string())
            );
        } else {
            panic!("expected KeyValue for Attributes");
        }
    }

    #[test]
    fn test_expanded_remove_no_attrs() {
        let p = SairedisParser::new();
        let r = p
            .parse(
                "2025-01-15.10:30:45.123456|r|SAI_OBJECT_TYPE_ROUTE_ENTRY:oid:0x1234",
                "test",
                "loader",
                1,
            )
            .unwrap();
        let expanded = r.expanded.as_ref().unwrap();
        assert_eq!(expanded[0].label, "Operation");
        assert_eq!(expanded[1].label, "Object Type");
        assert_eq!(expanded[2].label, "OID");
        // No Attributes field
        assert_eq!(expanded.len(), 3);
    }

    #[test]
    fn test_expanded_get_response_stateful() {
        let p = SairedisParser::new();
        // First parse a 'g' to set context
        p.parse(
            "2025-01-15.10:30:45.123456|g|SAI_OBJECT_TYPE_SWITCH:oid:0xABCD|SAI_SWITCH_ATTR_SRC_MAC_ADDRESS=",
            "test",
            "loader",
            1,
        );
        // Then parse 'G' response
        let r = p
            .parse(
                "2025-01-15.10:30:45.123457|G|SAI_STATUS_SUCCESS|SAI_SWITCH_ATTR_SRC_MAC_ADDRESS=00:11:22:33:44:55",
                "test",
                "loader",
                2,
            )
            .unwrap();
        let expanded = r.expanded.as_ref().unwrap();
        assert_eq!(expanded[0].label, "Operation");
        assert_eq!(
            expanded[0].value,
            crate::record::ExpandedValue::Text("GetResponse".to_string())
        );
        // Should have OID from stateful context
        let has_oid = expanded.iter().any(|f| f.label == "OID");
        assert!(has_oid);
        // Should have Request Context
        let has_request_ctx = expanded.iter().any(|f| f.label == "Request Context");
        assert!(has_request_ctx);
    }

    #[test]
    fn test_expanded_notification() {
        let p = SairedisParser::new();
        let r = p
            .parse(
                "2025-01-15.10:30:45.123456|n|fdb_event|[{\"fdb_entry\":\"{}\",\"fdb_event\":\"SAI_FDB_EVENT_LEARNED\"}]|",
                "test",
                "loader",
                1,
            )
            .unwrap();
        let expanded = r.expanded.as_ref().unwrap();
        assert_eq!(expanded[0].label, "Operation");
        assert!(expanded[0].value.eq(&crate::record::ExpandedValue::Text(
            "Notification: fdb_event".to_string()
        )));
    }
}