tailtales 0.2.0

Flexible log viewer for logfmt and other formats with filtering, filtering expressions, and real-time pipe following.
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
use chrono::prelude::*;
use std::{collections::HashMap, sync::RwLock};

#[derive(Debug)]
pub struct CsvParser {
    pub headers: Vec<String>,
    separator: char,
}

#[derive(Debug)]
pub enum Parser {
    Regex(regex::Regex),
    LogFmt(regex::Regex),
    AutoDatetime,
    Csv(Box<RwLock<CsvParser>>),
}

#[derive(Debug)]
#[allow(dead_code)]
pub enum ParserError {
    InvalidParser(String),
}

impl Parser {
    pub fn new(s: &str) -> Result<Parser, ParserError> {
        // split frist word of and the rest as a string
        let mut parts = s.splitn(2, ' ');
        let first = parts.next().ok_or(ParserError::InvalidParser(s.into()))?;
        match first {
            "logfmt" => return Ok(Parser::new_logfmt()),
            "regex" => {
                let rest = parts.next().ok_or(ParserError::InvalidParser(s.into()))?;
                return Ok(Parser::new_from_regex(rest));
            }
            "pattern" => {
                let rest = parts.next().ok_or(ParserError::InvalidParser(s.into()))?;
                return Ok(Parser::new_from_pattern(rest));
            }
            "autodatetime" => {
                return Ok(Parser::new_autodate());
            }
            "csv" => {
                return Ok(Parser::new_csv());
            }
            _ => Err(ParserError::InvalidParser(s.into())),
        }
    }

    pub fn new_from_pattern(linepattern: &str) -> Parser {
        // The linepatter lang is <_> equals .*
        // <name> is a named group "name"
        // Any other thing is to be matched exactly, including spaces, text and symbols.

        let mut repattern = "^".to_string();
        let mut inpattern: bool = false;
        let mut patternname = String::new();
        for c in linepattern.chars() {
            if c == '<' {
                inpattern = true;
                patternname.clear();
                continue;
            }
            if c == '>' {
                inpattern = false;
                if patternname != "_" && patternname != "" {
                    repattern.push_str("(?P<");
                    repattern.push_str(&patternname);
                    repattern.push_str(">");
                    repattern.push_str(".*?");
                    repattern.push_str(")");
                } else {
                    repattern.push_str("(");
                    repattern.push_str(".*?");
                    repattern.push_str(")");
                }
                continue;
            }
            if inpattern {
                if is_special_for_re(c) {
                    repattern.push('\\');
                }
                patternname.push(c);
            } else {
                if is_special_for_re(c) {
                    repattern.push('\\');
                }
                repattern.push(c);
            }
        }
        repattern.push_str("$");
        let re = regex::Regex::new(&repattern).unwrap();
        Parser::Regex(re)
    }

    pub fn new_logfmt() -> Parser {
        let re = regex::Regex::new("(?P<key>[^ ]*?)=(?P<value>\".*?\"|[^ ]*)( |$)").unwrap();
        Parser::LogFmt(re)
    }

    pub fn new_from_regex(regex: &str) -> Parser {
        let re = regex::Regex::new(regex).unwrap();
        Parser::Regex(re)
    }

    pub fn new_autodate() -> Parser {
        Parser::AutoDatetime
    }

    pub fn new_csv() -> Parser {
        Parser::Csv(Box::new(RwLock::new(CsvParser {
            headers: Vec::new(),
            separator: '?',
        })))
    }

    pub fn parse_line(&self, data: HashMap<String, String>, line: &str) -> HashMap<String, String> {
        match self {
            Parser::Regex(_) => self.parse_regex(data, line),
            Parser::AutoDatetime => self.parse_autodate(data, line),
            Parser::Csv(_) => self.parse_csv(data, line),
            Parser::LogFmt(_) => self.parse_logfmt(data, line),
        }
    }

    fn parse_logfmt(
        &self,
        mut _data: HashMap<String, String>,
        line: &str,
    ) -> HashMap<String, String> {
        let re: &regex::Regex = match self {
            Parser::LogFmt(re) => re,
            _ => panic!("Invalid parser type"),
        };
        let mut data = HashMap::new();
        for caps in re.captures_iter(line) {
            let key = caps["key"].to_string();
            let value = caps["value"].to_string();

            if value.starts_with('"') && value.ends_with('"') {
                let end = value.len() - 1;
                let value = if end > 1 {
                    value[1..end].to_string()
                } else {
                    "".to_string()
                };
                data.insert(key, value);
                continue;
            }

            data.insert(key, value);
        }
        data
    }

    fn parse_regex(
        &self,
        mut _data: HashMap<String, String>,
        line: &str,
    ) -> HashMap<String, String> {
        let re: &regex::Regex = match self {
            Parser::Regex(re) => re,
            _ => panic!("Invalid parser type"),
        };
        let mut data = HashMap::new();
        let caps = re.captures(line);
        match caps {
            Some(caps) => {
                for name in re.capture_names().flatten() {
                    if name.starts_with("_") {
                        continue; // ignore
                    }
                    let value = caps[name].to_string();
                    data.insert(name.to_string(), value);
                }
            }
            None => {}
        }
        data
    }
    fn parse_autodate(
        &self,
        mut data: HashMap<String, String>,
        _line: &str,
    ) -> HashMap<String, String> {
        if data.contains_key("timestamp") {
            return data;
        }
        let now = Utc::now().to_rfc3339();
        data.insert("timestamp".to_string(), now);
        data
    }

    fn parse_csv(&self, mut data: HashMap<String, String>, line: &str) -> HashMap<String, String> {
        let parser = match self {
            Parser::Csv(parser) => parser,
            _ => panic!("Invalid parser type"),
        };
        let parts = self.csv_read_data(parser, line);

        if parser.read().unwrap().headers.len() == 0 {
            // first parse is header
            let headers = &mut parser.write().unwrap().headers;
            headers.extend(parts.into_iter().map(|part| part.to_string()));
            return data;
        }

        // next use the header name to map the value
        let headers = &parser.read().unwrap().headers;
        for (i, part) in parts.into_iter().enumerate() {
            let key = match headers.get(i) {
                Some(header) => header.clone(),
                None => format!("header_{}", i),
            };
            data.insert(key, part.to_string());
        }
        data
    }
    fn csv_read_data(&self, parser: &RwLock<CsvParser>, line: &str) -> Vec<String> {
        let mut delimiter = parser.read().unwrap().separator;
        if delimiter == '?' {
            // guess from line
            delimiter = line.chars().find(|c| *c == ',' || *c == ';').unwrap_or(',');
            parser.write().unwrap().separator = delimiter;
        }

        let mut parts = Vec::new();
        let mut in_quotes = false;
        let mut next_is_escaped = false;
        let mut current = String::new();
        for char in line.chars() {
            if char == '"' && !next_is_escaped {
                in_quotes = !in_quotes;
            } else if char == delimiter && !in_quotes && !next_is_escaped {
                parts.push(current);
                current = String::new();
            } else if char == '\\' && !in_quotes && !next_is_escaped {
                next_is_escaped = true;
            } else {
                if next_is_escaped {
                    next_is_escaped = false;
                }
                current.push(char);
            }
        }
        parts.push(current);
        parts
    }
}

fn is_special_for_re(c: char) -> bool {
    match c {
        '.' | '*' | '+' | '?' | '(' | ')' | '[' | ']' | '{' | '}' | '^' | '$' | '|' | '\\' => true,
        _ => false,
    }
}

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

    #[test]
    fn test_is_special_for_re() {
        assert!(is_special_for_re('.'));
        assert!(is_special_for_re('*'));
        assert!(is_special_for_re('+'));
        assert!(is_special_for_re('?'));
        assert!(is_special_for_re('('));
        assert!(is_special_for_re(')'));
        assert!(is_special_for_re('['));
        assert!(is_special_for_re(']'));
        assert!(is_special_for_re('{'));
        assert!(is_special_for_re('}'));
        assert!(is_special_for_re('^'));
        assert!(is_special_for_re('$'));
        assert!(is_special_for_re('|'));
        assert!(is_special_for_re('\\'));
        assert!(!is_special_for_re('a'));
        assert!(!is_special_for_re('1'));
        assert!(!is_special_for_re(' '));
    }

    #[test]
    fn test_parser_new_valid_cases() {
        // Test logfmt
        let parser = Parser::new("logfmt").unwrap();
        matches!(parser, Parser::LogFmt(_));

        // Test regex
        let parser = Parser::new("regex .*").unwrap();
        matches!(parser, Parser::Regex(_));

        // Test pattern
        let parser = Parser::new("pattern <name> test").unwrap();
        matches!(parser, Parser::Regex(_));

        // Test autodatetime
        let parser = Parser::new("autodatetime").unwrap();
        matches!(parser, Parser::AutoDatetime);

        // Test csv
        let parser = Parser::new("csv").unwrap();
        matches!(parser, Parser::Csv(_));
    }

    #[test]
    fn test_parser_new_invalid_cases() {
        // Test invalid parser type
        let result = Parser::new("invalid");
        assert!(result.is_err());
        matches!(result.unwrap_err(), ParserError::InvalidParser(_));

        // Test regex without pattern
        let result = Parser::new("regex");
        assert!(result.is_err());

        // Test pattern without pattern
        let result = Parser::new("pattern");
        assert!(result.is_err());
    }

    #[test]
    fn test_new_from_pattern() {
        // Test simple pattern with named group
        let parser = Parser::new_from_pattern("Hello <name> world");
        if let Parser::Regex(re) = parser {
            let test_line = "Hello John world";
            let caps = re.captures(test_line).unwrap();
            assert_eq!(&caps["name"], "John");
        } else {
            panic!("Expected Regex parser");
        }

        // Test pattern with unnamed group
        let parser = Parser::new_from_pattern("Hello <_> world");
        if let Parser::Regex(re) = parser {
            let test_line = "Hello anyone world";
            assert!(re.is_match(test_line));
        }

        // Test pattern with special regex characters
        let parser = Parser::new_from_pattern("Test [brackets] and (parens)");
        if let Parser::Regex(re) = parser {
            let test_line = "Test [brackets] and (parens)";
            assert!(re.is_match(test_line));
        }
    }

    #[test]
    fn test_parse_logfmt() {
        let parser = Parser::new_logfmt();
        let data = HashMap::new();

        // Test simple key-value pairs
        let result = parser.parse_line(data.clone(), "key1=value1 key2=value2");
        assert_eq!(result.get("key1"), Some(&"value1".to_string()));
        assert_eq!(result.get("key2"), Some(&"value2".to_string()));

        // Test quoted values
        let result = parser.parse_line(data.clone(), "key1=\"quoted value\" key2=unquoted");
        assert_eq!(result.get("key1"), Some(&"quoted value".to_string()));
        assert_eq!(result.get("key2"), Some(&"unquoted".to_string()));

        // Test empty quoted value
        let result = parser.parse_line(data, "key1=\"\"");
        assert_eq!(result.get("key1"), Some(&"".to_string()));
    }

    #[test]
    fn test_parse_regex() {
        let parser = Parser::new_from_regex(r"(?P<method>\w+) (?P<path>/\S+)");
        let data = HashMap::new();

        let result = parser.parse_line(data, "GET /api/users");
        assert_eq!(result.get("method"), Some(&"GET".to_string()));
        assert_eq!(result.get("path"), Some(&"/api/users".to_string()));

        // Test line that doesn't match
        let result = parser.parse_line(HashMap::new(), "invalid line");
        assert!(result.is_empty());

        // Test with underscore prefixed group (should be ignored)
        let parser = Parser::new_from_regex(r"(?P<_ignore>\w+) (?P<keep>\w+)");
        let result = parser.parse_line(HashMap::new(), "ignore keep");
        assert!(!result.contains_key("_ignore"));
        assert_eq!(result.get("keep"), Some(&"keep".to_string()));
    }

    #[test]
    fn test_parse_autodate() {
        let parser = Parser::new_autodate();
        let mut data = HashMap::new();

        // Test adding timestamp when not present
        let result = parser.parse_line(data.clone(), "test line");
        assert!(result.contains_key("timestamp"));

        // Test preserving existing timestamp
        data.insert("timestamp".to_string(), "existing".to_string());
        let result = parser.parse_line(data, "test line");
        assert_eq!(result.get("timestamp"), Some(&"existing".to_string()));
    }

    #[test]
    fn test_parse_csv() {
        let parser = Parser::new_csv();
        let data = HashMap::new();

        // First line should be treated as headers
        let result = parser.parse_line(data.clone(), "name,age,city");
        assert!(result.is_empty()); // Headers don't produce data

        // Second line should use headers as keys
        let result = parser.parse_line(data.clone(), "John,25,NYC");
        assert_eq!(result.get("name"), Some(&"John".to_string()));
        assert_eq!(result.get("age"), Some(&"25".to_string()));
        assert_eq!(result.get("city"), Some(&"NYC".to_string()));

        // Test with semicolon separator
        let parser2 = Parser::new_csv();
        let _result = parser2.parse_line(HashMap::new(), "name;age;city");
        let result = parser2.parse_line(HashMap::new(), "Jane;30;LA");
        assert_eq!(result.get("name"), Some(&"Jane".to_string()));
        assert_eq!(result.get("age"), Some(&"30".to_string()));
        assert_eq!(result.get("city"), Some(&"LA".to_string()));
    }

    #[test]
    fn test_csv_read_data() {
        let parser = Parser::new_csv();
        if let Parser::Csv(csv_parser) = &parser {
            // Test comma separated values
            let result = parser.csv_read_data(csv_parser, "a,b,c");
            assert_eq!(result, vec!["a", "b", "c"]);

            // Test quoted values
            let result = parser.csv_read_data(csv_parser, "\"quoted,value\",normal");
            assert_eq!(result, vec!["quoted,value", "normal"]);

            // Test escaped characters
            let result = parser.csv_read_data(csv_parser, "value1,value\\,with\\,commas,value3");
            assert_eq!(result, vec!["value1", "value,with,commas", "value3"]);

            // Test empty fields
            let result = parser.csv_read_data(csv_parser, "a,,c");
            assert_eq!(result, vec!["a", "", "c"]);
        }
    }

    #[test]
    fn test_csv_with_quoted_fields() {
        let parser = Parser::new_csv();
        let data = HashMap::new();

        // Set up headers
        let _result = parser.parse_line(data.clone(), "name,description");

        // Test quoted field with comma
        let result = parser.parse_line(data, "John,\"Software Engineer, Senior\"");
        assert_eq!(result.get("name"), Some(&"John".to_string()));
        assert_eq!(
            result.get("description"),
            Some(&"Software Engineer, Senior".to_string())
        );
    }

    #[test]
    fn test_parse_line_routing() {
        // Test that parse_line correctly routes to the right parser
        let regex_parser = Parser::new_from_regex(r"(?P<word>\w+)");
        let result = regex_parser.parse_line(HashMap::new(), "hello");
        assert!(result.contains_key("word"));

        let autodate_parser = Parser::new_autodate();
        let result = autodate_parser.parse_line(HashMap::new(), "test");
        assert!(result.contains_key("timestamp"));

        let logfmt_parser = Parser::new_logfmt();
        let result = logfmt_parser.parse_line(HashMap::new(), "key=value");
        assert!(result.contains_key("key"));

        let csv_parser = Parser::new_csv();
        let _result = csv_parser.parse_line(HashMap::new(), "header1,header2");
        let result = csv_parser.parse_line(HashMap::new(), "value1,value2");
        assert!(result.contains_key("header1"));
    }
}