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

{
  "anchor": "parse_influxdb",
  "name": "parse_influxdb",
  "category": "Parse",
  "description": "Parses the `value` as an [InfluxDB line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/) string, producing a list of Vector-compatible metrics.",
  "arguments": [
    {
      "name": "value",
      "description": "The string representation of the InfluxDB line protocol to parse.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "array"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a valid InfluxDB line protocol string.",
    "field set contains a field value of type `string`.",
    "field set contains a `NaN` field value."
  ],
  "examples": [
    {
      "title": "Parse InfluxDB line protocol",
      "source": "parse_influxdb!(\"cpu,host=A,region=us-west usage_system=64i,usage_user=10u,temperature=50.5,on=true,sleep=false 1590488773254420000\")",
      "return": [
        {
          "name": "cpu_usage_system",
          "tags": {
            "host": "A",
            "region": "us-west"
          },
          "timestamp": "2020-05-26T10:26:13.254420Z",
          "kind": "absolute",
          "gauge": {
            "value": 64.0
          }
        },
        {
          "name": "cpu_usage_user",
          "tags": {
            "host": "A",
            "region": "us-west"
          },
          "timestamp": "2020-05-26T10:26:13.254420Z",
          "kind": "absolute",
          "gauge": {
            "value": 10.0
          }
        },
        {
          "name": "cpu_temperature",
          "tags": {
            "host": "A",
            "region": "us-west"
          },
          "timestamp": "2020-05-26T10:26:13.254420Z",
          "kind": "absolute",
          "gauge": {
            "value": 50.5
          }
        },
        {
          "name": "cpu_on",
          "tags": {
            "host": "A",
            "region": "us-west"
          },
          "timestamp": "2020-05-26T10:26:13.254420Z",
          "kind": "absolute",
          "gauge": {
            "value": 1.0
          }
        },
        {
          "name": "cpu_sleep",
          "tags": {
            "host": "A",
            "region": "us-west"
          },
          "timestamp": "2020-05-26T10:26:13.254420Z",
          "kind": "absolute",
          "gauge": {
            "value": 0.0
          }
        }
      ]
    }
  ],
  "notices": [
    "This function will return a log event with the shape of a Vector-compatible metric,\nbut not a metric event itself. You will likely want to pipe the output of this\nfunction through a `log_to_metric` transform with the option `all_metrics` set to\n`true` to convert the metric-shaped log events to metric events so _real_ metrics\nare produced.",
    "The only metric type that is produced is a `gauge`. Each metric name is prefixed\nwith the `measurement` field, followed by an underscore (`_`), and then the\n`field key` field.",
    "`string` is the only type that is not supported as a field value, due to limitations\nof Vector's metric model."
  ],
  "pure": true
}