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

{
  "anchor": "get_env_var",
  "name": "get_env_var",
  "category": "System",
  "description": "Returns the value of the environment variable specified by `name`.",
  "arguments": [
    {
      "name": "name",
      "description": "The name of the environment variable.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "internal_failure_reasons": [
    "Environment variable `name` does not exist.",
    "The value of environment variable `name` is not valid Unicode"
  ],
  "examples": [
    {
      "title": "Get an environment variable",
      "source": "get_env_var!(\"HOME\")",
      "return": "/root"
    }
  ],
  "pure": true
}