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

{
  "anchor": "parse_common_log",
  "name": "parse_common_log",
  "category": "Parse",
  "description": "Parses the `value` using the [Common Log Format](https://httpd.apache.org/docs/current/logs.html#common) (CLF).",
  "arguments": [
    {
      "name": "value",
      "description": "The string to parse.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "timestamp_format",
      "description": "The [date/time format](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) to use for\nencoding the timestamp.",
      "required": false,
      "type": [
        "string"
      ],
      "default": "%d/%b/%Y:%T %z"
    }
  ],
  "return": {
    "types": [
      "object"
    ]
  },
  "internal_failure_reasons": [
    "`value` does not match the Common Log Format.",
    "`timestamp_format` is not a valid format string.",
    "The timestamp in `value` fails to parse using the provided `timestamp_format`."
  ],
  "examples": [
    {
      "title": "Parse using Common Log Format (with default timestamp format)",
      "source": "parse_common_log!(s'127.0.0.1 bob frank [10/Oct/2000:13:55:36 -0700] \"GET /apache_pb.gif HTTP/1.0\" 200 2326')",
      "return": {
        "host": "127.0.0.1",
        "identity": "bob",
        "message": "GET /apache_pb.gif HTTP/1.0",
        "method": "GET",
        "path": "/apache_pb.gif",
        "protocol": "HTTP/1.0",
        "size": 2326,
        "status": 200,
        "timestamp": "2000-10-10T20:55:36Z",
        "user": "frank"
      }
    },
    {
      "title": "Parse using Common Log Format (with custom timestamp format)",
      "source": "parse_common_log!(\n    s'127.0.0.1 bob frank [2000-10-10T20:55:36Z] \"GET /apache_pb.gif HTTP/1.0\" 200 2326',\n    \"%+\"\n)\n",
      "return": {
        "host": "127.0.0.1",
        "identity": "bob",
        "message": "GET /apache_pb.gif HTTP/1.0",
        "method": "GET",
        "path": "/apache_pb.gif",
        "protocol": "HTTP/1.0",
        "size": 2326,
        "status": 200,
        "timestamp": "2000-10-10T20:55:36Z",
        "user": "frank"
      }
    }
  ],
  "notices": [
    "Missing information in the log message may be indicated by `-`. These fields are omitted in the result."
  ],
  "pure": true
}