Repository navigation
Expand file tree
/
Copy path.schema.json
More file actions
510 lines (510 loc) · 15.8 KB
/
Copy path.schema.json
File metadata and controls
510 lines (510 loc) · 15.8 KB
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
{
"$id": "https://raw.githubusercontent.com/timberio/vector/master/.meta/schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Vector Metadata Schema",
"type": "object",
"required": [ "sinks" ],
"properties": {
"sinks": {
"type": "object",
"description": "An object represeting all Vector sinks keyed by the sink's name.",
"patternProperties": {
"^[a-z0-9_]+$": {
"$ref": "#/definitions/sink"
}
}
},
"sources": {
"type": "object",
"description": "An object represeting all Vector soures keyed by the source's name.",
"patternProperties": {
"^[a-z0-9_]+$": {
"$ref": "#/definitions/source"
}
}
},
"tests": {
"description": "Vector configuration unit tests reference.",
"$ref": "#/definitions/field"
},
"transforms": {
"type": "object",
"description": "An object represeting all Vector transforms keyed by the transform's name.",
"patternProperties": {
"^[a-z0-9_]+$": {
"$ref": "#/definitions/transform"
}
}
}
},
"definitions": {
"event_types": {
"type": "array",
"description": "A list of allowed Vector event types.",
"items": {
"type": "string",
"enum": ["log", "metric"]
}
},
"fields": {
"type": "object",
"description": "An object of fields keyed by the field's name.",
"patternProperties": {
"^[a-z0-9_]+$": {
"$ref": "#/definitions/field"
}
}
},
"field": {
"type": "object",
"description": "A Vector field, such as a component option, environment variable, log schema field, etc.",
"additionalProperties": false,
"required": ["description", "type"],
"properties": {
"category": {
"type": "string",
"description": "The field category. This will group the option with other related category options."
},
"children": {
"$ref": "#/definitions/fields"
},
"common": {
"type": "boolean",
"description": "If this option is a common option. Common options are shown by default in the documentation. It's a way to reduce the noise in configuration examples."
},
"default": {
"description": "The default value of this option, if applicable."
},
"description": {
"type": "string",
"description": "The human friendly description of this option, markdown syntax is supported.",
"minLength": 10
},
"display": {
"type": "string",
"description": "Only relevant for `object` types. This determine the TOML display style.",
"enum": ["inline"]
},
"enum": {
"type": "object",
"description": "Enumeration values for this option.",
"patternProperties": {
"^[a-z0-9_]+$": {
"type": "string",
"minLength": 10
}
}
},
"examples": {
"type": "array",
"description": "An array of example values used for documentation purposes."
},
"groups": {
"type": "array",
"description": "The overaching group that this configuration belongs to. This is an advanced option that should be used for large groups of mutually exclusive options. For example, a set of options specifically for v1 and another set for v2.",
"items": {
"type": "string"
}
},
"partition_key": {
"type": "boolean",
"description": "If this option can be used to partition data. For example, the `path` option in the `aws_s3` sink."
},
"relevant_when": {
"type": "object",
"description": "An object representing the conditions when an option is relevant. This is commonly used in conjuntion with `type` or `strategy` options."
},
"required": {
"type": "boolean",
"description": "If this option is required."
},
"sort": {
"type": "int",
"description": "Manual sorting option."
},
"templateable": {
"type": "boolean",
"description": "If this option support Vectors template/event field interpolation syntax."
},
"type": {
"type": "string",
"description": "The option value type.",
"enum": [
"bool",
"float",
"int",
"string",
"struct",
"table",
"timestamp",
"[float]",
"[string]",
"[table]"
]
},
"unit": {
"type": "string",
"description": "The unit of measurement for the option value",
"enum": ["bytes", "events", "milliseconds", "requests", "seconds"]
}
}
},
"operating_systems": {
"type": "array",
"description": "A list of Vector support operating systems.",
"items": {
"type": "string",
"enum": ["Linux", "MacOS", "Windows"]
}
},
"output": {
"type": "object",
"description": "An array of output examples used to demonstrate a component's output.",
"additionalProperties": false,
"properties": {
"examples": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["body", "label"],
"properties": {
"body": {
"type": "string",
"description": "The output exmaple body. Markdown syntax is supported."
},
"label": {
"type": "string",
"description": "The output label. This will be used in the tab name if multiple output examples are provided."
}
}
}
},
"fields": {
"$ref": "#/definitions/fields"
}
}
},
"requirements": {
"type": "object",
"properties": {
"additional": {
"type": "string",
"description": "Additional free-form requirements. Markdown is supported and they should be in list format."
},
"network": {
"type": "boolean",
"description": "Is the network required for this component?"
}
}
},
"sink": {
"type": "object",
"description": "A component that outputs/sends data from Vector.",
"additionalProperties": false,
"required": [
"beta",
"common",
"delivery_guarantee",
"egress_method",
"function_category",
"requirements",
"title",
"write_to_description"
],
"anyOf": [
{
"properties": {
"egress_method": { "const": "batching" }
},
"required": [
]
},
{
"properties": {
"egress_method": { "const": "exposing" }
},
"required": []
},
{
"properties": {
"egress_method": { "const": "streaming" }
},
"required": []
}
],
"properties": {
"beta": {
"type": "boolean",
"description": "Is this component in beta status?"
},
"common": {
"type": "boolean",
"description": "Is this sink common? Shold it be highlighted in a list of all sinks?"
},
"delivery_guarantee": {
"type": "string",
"description": "The sink's delivery guarantee.",
"enum": ["at_least_once", "best_effort"]
},
"egress_method": {
"type": "string",
"description": "The sink's egress method.",
"enum": ["batching", "exposing", "streaming"]
},
"env_vars": {
"$ref": "#/definitions/fields",
"description": "The environment variables supported by this source, keyed by the variables's name."
},
"function_category": {
"type": "string",
"description": "The function category the sink serves. Used for filtering.",
"enum": [
"proxy",
"test",
"transmit"
]
},
"healthcheck": {
"type": "boolean",
"description": "If the sink implements a healthcheck."
},
"input_types": {
"type": "array",
"description": "The allow event input types.",
"items": {
"type": "string",
"enum": ["log", "metric"]
}
},
"min_version": {
"type": "string",
"description": "The minimum version supported for the system this component interfaces with."
},
"options": {
"$ref": "#/definitions/fields",
"description": "The options provided by this sink, keyed by the option's name."
},
"output": {
"$ref": "#/definitions/output",
"description": "Output examples of this sink."
},
"requirements": {
"$ref": "#/definitions/requirements",
"description": "Component requirements"
},
"service_limits_short_link": {
"type": "string",
"description": "A link to the target service's limits, if applicable.",
"minLength": 1
},
"service_name": {
"type": "string",
"description": "The name of the underlying service that this component integrates with."
},
"service_providers": {
"type": "array",
"description": "A list of providers that offer this service.",
"items": {
"type": "string",
"enum": [
"AWS",
"Confluent",
"Datadog",
"Elastic",
"Google",
"InfluxData",
"New Relic",
"Splunk"
]
}
},
"title": {
"type": "string",
"description": "Short title for the sink",
"minLength": 1,
"max_lenfth": 50
},
"write_to_description": {
"type": "string",
"description": "Short one sentence description of where the sink writes.",
"minLength": 5
}
}
},
"source": {
"type": "object",
"description": "A component that receives/ingests data.",
"additionalProperties": false,
"required": [
"beta",
"common",
"delivery_guarantee",
"function_category",
"requirements",
"through_description",
"title"
],
"properties": {
"beta": {
"type": "boolean",
"description": "Is the source in beta status?"
},
"common": {
"type": "boolean",
"description": "Is this a common source that should be highlighted in a full list of sources?"
},
"delivery_guarantee": {
"type": "string",
"description": "The source's delivery guarantee",
"enum": ["at_least_once", "best_effort"]
},
"env_vars": {
"$ref": "#/definitions/fields",
"description": "The environment variables supported by this source, keyed by the variables's name."
},
"except_operating_systems": {
"$ref": "#/definitions/operating_systems",
"description": "A blacklist of operating systems not supported by this source."
},
"function_category": {
"type": "string",
"description": "The source's function category, used for filtering.",
"enum": [
"collect&
8000
quot;,
"proxy",
"receive"
]
},
"min_version": {
"type": "string",
"description": "The minimum version supported for the system this component interfaces with."
},
"only_operating_systems": {
"$ref": "#/definitions/operating_systems",
"description": "A whitelist of operating systems supported by this source."
},
"options": {
"$ref": "#/definitions/fields",
"description": "Options provided by this source, keyed by the option name."
},
"output": {
"type": "object",
"description": "Output examples for this source.",
"additionalProperties": false,
"properties": {
"log": {
"$ref": "#/definitions/output"
},
"metric": {
"$ref": "#/definitions/output"
}
}
},
"output_types": {
"$ref": "#/definitions/event_types",
"description": "The types of events this source outputs."
},
"requirements": {
"$ref": "#/definitions/requirements",
"description": "Component requirements"
},
"service_name": {
"type": "string",
"description": "The name of the underlying service that this component integrates with."
},
"through_description": {
"type": "string",
"decription": "A short one sentence description describing how this source emits events.",
"minLength": 5
},
"title": {
"type": "string",
"description": "A simple title for this source, typically one word.",
"minLength": 1,
"max_lenfth": 50
}
}
},
"transform": {
"type": "object",
"additionalProperties": false,
"required": [
"allow_you_to_description",
"beta",
"common",
"function_category",
"requirements",
"title"
],
"properties": {
"allow_you_to_description": {
"type": "string",
"description": "A short one sentence description for this tramsform.",
"minLength": 5
},
"beta": {
"type": "boolean",
"description": "Is this transform in beta status?"
},
"common": {
"type": "boolean",
"description": "Is this a common transform that should be highlighted in a full list of transforms?"
},
"env_vars": {
"$ref": "#/definitions/fields",
"description": "A list of supported environment variables by this transform."
},
"function_category": {
"type": "string",
"description": "The function category this transform performed. Used for filtering.",
"enum": [
"convert",
"enrich",
"filter",
"parse",
"program",
"sanitize",
"shape",
"merge"
]
},
"input_types": {
"$ref": "#/definitions/event_types",
"description": "The types of events that this transform can receive."
},
"options": {
"$ref": "#/definitions/fields",
"description": "The options provided by this transform, keyed by the option name."
},
"output": {
"type": "object",
"description": "Output examples of this transform",
"additionalProperties": false,
"properties": {
"log": {
"$ref": "#/definitions/output"
},
"metric": {
"$ref": "#/definitions/output"
}
}
},
"output_types": {
"$ref": "#/definitions/event_types",
"description": "The types of events this transform outputs."
},
"requirements": {
"$ref": "#/definitions/requirements",
"description": "Component requirements"
},
"title": {
"type": "string",
"description": "A simple title for this transform, typically one word.",
"minLength": 1,
"max_lenfth": 50
}
}
}
}
}