This repository has been archived by the owner on Oct 22, 2020. It is now read-only.
forked from vectordotdev/vector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metric_fields.toml
175 lines (154 loc) · 3.48 KB
/
metric_fields.toml
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
[metric_fields.counter]
type = "struct"
optional = true
description = """\
A single value that can _only_ be incremented, it cannot be incremented.\
"""
[metric_fields.counter.fields.name]
type = "string"
examples = ["login.count"]
optional = false
description = """\
The metric name.\
"""
[metric_fields.counter.fields.val]
type = "double"
examples = [10.2]
optional = false
description = """\
Amount to increment.\
"""
[metric_fields.counter.fields.tags]
type = "map"
examples = [{host = "my.host.com"}]
optional = false
description = """\
The metric name.\
"""
[metric_fields.counter.fields.timestamp]
type = "timestamp"
examples = ["2019-11-01T21:15:47.443232Z"]
optional = false
description = """\
Time metric was created/ingested.\
"""
[metric_fields.histogram]
type = "struct"
optional = true
description = """\
Also called a "timer". A `histogram` represents the frequency distribution of a \
value. This is commonly used for timings, helping to understand quantiles, max, \
min, and other aggregations.\
"""
[metric_fields.histogram.fields.name]
type = "string"
examples = ["duration_ms"]
optional = false
description = """\
The metric name.\
"""
[metric_fields.histogram.fields.val]
type = "double"
examples = [2.6]
optional = false
description = """\
Specific value.\
"""
[metric_fields.histogram.fields.sample_rate]
type = "double"
examples = [1]
optional = true
description = """\
The bucket/distribution the metric is a part of.\
"""
[metric_fields.histogram.fields.tags]
type = "map"
examples = [{host = "my.host.com"}]
optional = false
description = """\
The metric name.\
"""
[metric_fields.histogram.fields.timestamp]
type = "timestamp"
examples = ["2019-11-01T21:15:47.443232Z"]
optional = false
description = """\
Time metric was created/ingested.\
"""
[metric_fields.gauge]
type = "struct"
optional = true
description = """\
A gauge represents a point-in-time value that can increase and decrease. \
Vector's internal gauge type represents changes to that value. Gauges should be \
used to track fluctuations in values, like current memory or CPU usage.\
"""
[metric_fields.gauge.fields.direction]
type = "string"
enum = ["plus", "minus"]
optional = false
description = """\
The direction to increase or decrease the gauge value.\
"""
[metric_fields.gauge.fields.name]
type = "string"
examples = ["memory_rss"]
optional = false
description = """\
The metric name.\
"""
[metric_fields.gauge.fields.val]
type = "double"
examples = [554222.0]
optional = false
description = """\
Specific value.\
"""
[metric_fields.gauge.fields.tags]
type = "map"
examples = [{host = "my.host.com"}]
optional = false
description = """\
The metric name.\
"""
[metric_fields.gauge.fields.timestamp]
type = "timestamp"
examples = ["2019-11-01T21:15:47.443232Z"]
optional = false
description = """\
Time metric was created/ingested.\
"""
[metric_fields.set]
type = "struct"
optional = true
description = """\
A set represents a count of unique values, AKA the cardinality.\
"""
[metric_fields.set.fields.name]
type = "string"
examples = ["unique_users"]
optional = false
description = """\
The metric name.\
"""
[metric_fields.set.fields.val]
type = "double"
examples = [12]
optional = false
description = """\
Specific value.\
"""
[metric_fields.set.fields.tags]
type = "map"
examples = [{host = "my.host.com"}]
optional = false
description = """\
The metric name.\
"""
[metric_fields.set.fields.timestamp]
type = "timestamp"
examples = ["2019-11-01T21:15:47.443232Z"]
optional = false
description = """\
Time metric was created/ingested.\
"""