vrl 0.32.0

Vector Remap Language
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

use lalrpop_util::{ParseError, lalrpop_mod};

use super::{ast::GrokPattern, lexer::Lexer};

lalrpop_mod!(
    #[allow(clippy::all)]
    #[allow(unused)]
    parser,
    "/src/datadog/grok/parser.rs"
);

/// Parses grok patterns as %{MATCHER:FIELD:FILTER}
#[allow(dead_code)] // will be used in the follow-up PRs
pub fn parse_grok_pattern(input: &str) -> Result<GrokPattern, String> {
    let lexer = Lexer::new(input);
    parser::GrokFilterParser::new()
        .parse(input, lexer)
        .map_err(|e| match e {
            ParseError::User { error } => error.to_string(),
            _ => format!("invalid grok pattern: {input}"),
        })
}

#[cfg(test)]
mod tests {
    use crate::owned_value_path;
    use crate::value::Value;

    use super::super::ast::{Destination, Function, FunctionArgument};
    use super::*;

    #[test]
    fn parse_grok_filter() {
        let input = r#"%{date:e-http.status.abc[".\""]:integer("a. df",.123,1.23e-32, true, null, 123e-5)}"#;
        let parsed = parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
        assert_eq!(parsed.match_fn.name, "date");
        let destination = parsed.destination.unwrap();
        assert_eq!(
            destination.path,
            owned_value_path!("e-http", "status", "abc", r#".""#)
        );
        let filter = destination.filter_fn.unwrap();
        assert_eq!(filter.name, "integer");
        let args = filter.args.unwrap();
        let expected_args = [
            "a. df".into(),
            0.123.into(),
            1.23e-32_f64.into(),
            true.into(),
            Value::Null,
            123e-5.into(),
        ];
        for (i, arg) in args.iter().enumerate() {
            match arg {
                FunctionArgument::Arg(arg) => assert_eq!(arg, expected_args.get(i).unwrap()),
                _ => panic!("failed to parse arguments"),
            };
        }
    }

    #[test]
    fn empty_field() {
        let input = "%{data:}";
        let parsed = parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
        assert_eq!(parsed.destination, None);
    }

    #[test]
    fn escaped_quotes() {
        let input = r#"%{data:field:filter("escaped \"quotes\"")}"#;
        let parsed = parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
        assert_eq!(
            parsed.destination,
            Some(Destination {
                path: owned_value_path!("field"),
                filter_fn: Some(Function {
                    name: "filter".to_string(),
                    args: Some(vec![FunctionArgument::Arg(r#"escaped "quotes""#.into())])
                })
            })
        );
    }

    #[test]
    fn empty_field_with_filter() {
        let input = "%{data::json}";
        let parsed = parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
        assert_eq!(
            parsed.destination,
            Some(Destination {
                path: owned_value_path!(),
                filter_fn: Some(Function {
                    name: "json".to_string(),
                    args: None,
                })
            })
        );
    }

    #[test]
    fn invalid_escape() {
        let input = r#"%{data::json("\:")}"#;
        assert_eq!(
            parse_grok_pattern(input).expect_err("must be an invalid escape error"),
            "invalid escape literal '\\:'"
        );
    }

    #[test]
    fn escaped_new_line() {
        let input = r#"%{data::array("\\n")}"#;
        let parsed = parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
        assert_eq!(
            parsed.destination,
            Some(Destination {
                path: owned_value_path!(),
                filter_fn: Some(Function {
                    name: "array".to_string(),
                    args: Some(vec![FunctionArgument::Arg("\n".into())]),
                })
            })
        );
    }

    #[test]
    fn parses_string_with_escaped_quote_followed_by_multibyte_character() {
        let input = r#"%{regex("[^\\\"“]*"):traefik.backend_url}"#;
        parse_grok_pattern(input).unwrap_or_else(|error| {
            panic!("Problem parsing grok: {error:?}");
        });
    }
}