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

{
  "anchor": "parse_bytes",
  "name": "parse_bytes",
  "category": "Parse",
  "description": "Parses the `value` into a human-readable bytes format specified by `unit` and `base`.",
  "arguments": [
    {
      "name": "value",
      "description": "The string of the duration with either binary or SI unit.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "unit",
      "description": "The output units for the byte.",
      "required": true,
      "type": [
        "string"
      ],
      "enum": {
        "B": "Bytes",
        "kiB": "Kilobytes (1024 bytes)",
        "MiB": "Megabytes (1024 ** 2 bytes)",
        "GiB": "Gigabytes (1024 ** 3 bytes)",
        "TiB": "Terabytes (1024 gigabytes)",
        "PiB": "Petabytes (1024 ** 2 gigabytes)",
        "EiB": "Exabytes (1024 ** 3 gigabytes)",
        "kB": "Kilobytes (1 thousand bytes in SI)",
        "MB": "Megabytes (1 million bytes in SI)",
        "GB": "Gigabytes (1 billion bytes in SI)",
        "TB": "Terabytes (1 thousand gigabytes in SI)",
        "PB": "Petabytes (1 million gigabytes in SI)",
        "EB": "Exabytes (1 billion gigabytes in SI)"
      }
    },
    {
      "name": "base",
      "description": "The base for the byte, either 2 or 10.",
      "required": false,
      "type": [
        "string"
      ],
      "default": "2"
    }
  ],
  "return": {
    "types": [
      "float"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a properly formatted bytes."
  ],
  "examples": [
    {
      "title": "Parse bytes (kilobytes)",
      "source": "parse_bytes!(\"1024KiB\", unit: \"MiB\")",
      "return": 1.0
    },
    {
      "title": "Parse kilobytes in default binary units",
      "source": "parse_bytes!(\"1KiB\", unit: \"B\")",
      "return": 1024.0
    },
    {
      "title": "Parse bytes in SI unit (terabytes)",
      "source": "parse_bytes!(\"4TB\", unit: \"MB\", base: \"10\")",
      "return": 4000000.0
    },
    {
      "title": "Parse gigabytes in decimal units",
      "source": "parse_bytes!(\"1GB\", unit: \"B\", base: \"10\")",
      "return": 1000000000.0
    },
    {
      "title": "Parse bytes in ambiguous unit (gigabytes)",
      "source": "parse_bytes!(\"1GB\", unit: \"B\", base: \"2\")",
      "return": 1073741824.0
    },
    {
      "title": "Parse gigabytes in ambiguous decimal units",
      "source": "parse_bytes!(\"1GB\", unit: \"MB\", base: \"2\")",
      "return": 1024.0
    }
  ],
  "pure": true
}