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

{
  "anchor": "parse_duration",
  "name": "parse_duration",
  "category": "Parse",
  "description": "Parses the `value` into a human-readable duration format specified by `unit`.",
  "arguments": [
    {
      "name": "value",
      "description": "The string of the duration.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "unit",
      "description": "The output units for the duration.",
      "required": true,
      "type": [
        "string"
      ],
      "enum": {
        "ns": "Nanoseconds (1 billion nanoseconds in a second)",
        "us": "Microseconds (1 million microseconds in a second)",
        "µs": "Microseconds (1 million microseconds in a second)",
        "ms": "Milliseconds (1 thousand microseconds in a second)",
        "cs": "Centiseconds (100 centiseconds in a second)",
        "ds": "Deciseconds (10 deciseconds in a second)",
        "s": "Seconds",
        "m": "Minutes (60 seconds in a minute)",
        "h": "Hours (60 minutes in an hour)",
        "d": "Days (24 hours in a day)"
      }
    }
  ],
  "return": {
    "types": [
      "float"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a properly formatted duration."
  ],
  "examples": [
    {
      "title": "Parse duration (milliseconds)",
      "source": "parse_duration!(\"1005ms\", unit: \"s\")",
      "return": 1.005
    },
    {
      "title": "Parse multiple durations (seconds & milliseconds)",
      "source": "parse_duration!(\"1s 1ms\", unit: \"ms\")",
      "return": 1001.0
    }
  ],
  "pure": true
}