/
integrations_user_config_schema.json
384 lines (384 loc) · 14.1 KB
/
integrations_user_config_schema.json
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
{
"dashboard": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"datadog": {
"additionalProperties": false,
"properties": {
"kafka_custom_metrics": {
"items": {
"example": "kafka.log.log_size",
"maxLength": 1024,
"title": "Metric name",
"type": "string"
},
"maxItems": 1024,
"title": "List of custom metrics",
"type": "array"
}
},
"type": "object"
},
"external_aws_cloudwatch_logs": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"external_elasticsearch_logs": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"external_google_cloud_logging": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"jolokia": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"kafka_connect": {
"additionalProperties": false,
"properties": {
"kafka_connect": {
"additionalProperties": false,
"properties": {
"config_storage_topic": {
"example": "__connect_configs",
"maxLength": 249,
"title": "The name of the topic where connector and task configuration data are stored.This must be the same for all workers with the same group_id.",
"type": "string"
},
"group_id": {
"example": "connect",
"maxLength": 249,
"title": "A unique string that identifies the Connect cluster group this worker belongs to.",
"type": "string"
},
"offset_storage_topic": {
"example": "__connect_offsets",
"maxLength": 249,
"title": "The name of the topic where connector and task configuration offsets are stored.This must be the same for all workers with the same group_id.",
"type": "string"
},
"status_storage_topic": {
"example": "__connect_status",
"maxLength": 249,
"title": "The name of the topic where connector and task configuration status updates are stored.This must be the same for all workers with the same group_id.",
"type": "string"
}
},
"title": "Kafka Connect service configuration values",
"type": "object"
}
},
"title": "Integration user config",
"type": "object"
},
"kafka_mirrormaker": {
"additionalProperties": false,
"properties": {
"cluster_alias": {
"description": "The alias under which the Kafka cluster is known to MirrorMaker. Can contain the following symbols: ASCII alphanumerics, '.', '_', and '-'.",
"example": "kafka-abc",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9_.-]+$",
"title": "Kafka cluster alias",
"type": "string",
"user_error": "Must consist of alpha-numeric ASCII characters, dashes, underscores, and dots."
}
},
"title": "Integration user config",
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"elasticsearch_index_days_max": {
"default": 3,
"example": 5,
"maximum": 10000,
"minimum": 1,
"title": "Elasticsearch index retention limit",
"type": "integer"
},
"elasticsearch_index_prefix": {
"default": "logs",
"example": "logs",
"maxLength": 1024,
"minLength": 1,
"title": "Elasticsearch index prefix",
"type": "string"
}
},
"type": "object"
},
"m3aggregator": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"m3coordinator": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"database": {
"example": "metrics",
"maxLength": 40,
"pattern": "^[_A-Za-z0-9][-_A-Za-z0-9]{0,39}$",
"title": "Name of the database where to store metric datapoints. Only affects PostgreSQL destinations. Defaults to 'metrics'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.",
"type": "string",
"user_error": "Must consist of alpha-numeric characters, underscores or dashes, may not start with dash, max 40 characters"
},
"retention_days": {
"example": 30,
"maximum": 10000,
"minimum": 0,
"title": "Number of days to keep old metrics. Only affects PostgreSQL destinations. Set to 0 for no automatic cleanup. Defaults to 30 days.",
"type": "integer"
},
"ro_username": {
"example": "metrics_reader",
"maxLength": 40,
"pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,39}$",
"title": "Name of a user that can be used to read metrics. This will be used for Grafana integration (if enabled) to prevent Grafana users from making undesired changes. Only affects PostgreSQL destinations. Defaults to 'metrics_reader'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.",
"type": "string",
"user_error": "Must consist of alpha-numeric characters, dots, underscores or dashes, may not start with dash or dot, max 40 characters"
},
"source_mysql": {
"additionalProperties": false,
"properties": {
"telegraf": {
"additionalProperties": false,
"properties": {
"gather_event_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.EVENT_WAITS",
"type": "boolean"
},
"gather_file_events_stats": {
"example": false,
"title": "gather metrics from PERFORMANCE_SCHEMA.FILE_SUMMARY_BY_EVENT_NAME",
"type": "boolean"
},
"gather_index_io_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_INDEX_USAGE",
"type": "boolean"
},
"gather_info_schema_auto_inc": {
"example": false,
"title": "Gather auto_increment columns and max values from information schema",
"type": "boolean"
},
"gather_innodb_metrics": {
"example": true,
"title": "Gather metrics from INFORMATION_SCHEMA.INNODB_METRICS",
"type": "boolean"
},
"gather_perf_events_statements": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.EVENTS_STATEMENTS_SUMMARY_BY_DIGEST",
"type": "boolean"
},
"gather_process_list": {
"example": true,
"title": "Gather thread state counts from INFORMATION_SCHEMA.PROCESSLIST",
"type": "boolean"
},
"gather_slave_status": {
"example": true,
"title": "Gather metrics from SHOW SLAVE STATUS command output",
"type": "boolean"
},
"gather_table_io_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_TABLE",
"type": "boolean"
},
"gather_table_lock_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_LOCK_WAITS",
"type": "boolean"
},
"gather_table_schema": {
"example": true,
"title": "Gather metrics from INFORMATION_SCHEMA.TABLES",
"type": "boolean"
},
"perf_events_statements_digest_text_limit": {
"example": 120,
"maximum": 2048,
"minimum": 1,
"title": "Truncates digest text from perf_events_statements into this many characters",
"type": "integer"
},
"perf_events_statements_limit": {
"example": 250,
"maximum": 4000,
"minimum": 1,
"title": "Limits metrics from perf_events_statements",
"type": "integer"
},
"perf_events_statements_time_limit": {
"example": 86400,
"maximum": 2592000,
"minimum": 1,
"title": "Only include perf_events_statements whose last seen is less than this many seconds",
"type": "integer"
}
},
"title": "Configuration options for Telegraf MySQL input plugin",
"type": "object"
}
},
"title": "Configuration options for metrics where source service is MySQL",
"type": "object"
},
"username": {
"example": "metrics_writer",
"maxLength": 40,
"pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,39}$",
"title": "Name of the user used to write metrics. Only affects PostgreSQL destinations. Defaults to 'metrics_writer'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.",
"type": "string",
"user_error": "Must consist of alpha-numeric characters, dots, underscores or dashes, may not start with dash or dot, max 40 characters"
}
},
"title": "Integration user config",
"type": "object"
},
"mirrormaker": {
"additionalProperties": false,
"properties": {
"mirrormaker_whitelist": {
"default": ".*",
"example": ".*",
"maxLength": 1000,
"minLength": 1,
"title": "Mirrormaker topic whitelist",
"type": "string"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"properties": {
"source_mysql": {
"additionalProperties": false,
"properties": {
"telegraf": {
"additionalProperties": false,
"properties": {
"gather_event_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.EVENT_WAITS",
"type": "boolean"
},
"gather_file_events_stats": {
"example": false,
"title": "gather metrics from PERFORMANCE_SCHEMA.FILE_SUMMARY_BY_EVENT_NAME",
"type": "boolean"
},
"gather_index_io_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_INDEX_USAGE",
"type": "boolean"
},
"gather_info_schema_auto_inc": {
"example": false,
"title": "Gather auto_increment columns and max values from information schema",
"type": "boolean"
},
"gather_innodb_metrics": {
"example": true,
"title": "Gather metrics from INFORMATION_SCHEMA.INNODB_METRICS",
"type": "boolean"
},
"gather_perf_events_statements": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.EVENTS_STATEMENTS_SUMMARY_BY_DIGEST",
"type": "boolean"
},
"gather_process_list": {
"example": true,
"title": "Gather thread state counts from INFORMATION_SCHEMA.PROCESSLIST",
"type": "boolean"
},
"gather_slave_status": {
"example": true,
"title": "Gather metrics from SHOW SLAVE STATUS command output",
"type": "boolean"
},
"gather_table_io_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_TABLE",
"type": "boolean"
},
"gather_table_lock_waits": {
"example": false,
"title": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_LOCK_WAITS",
"type": "boolean"
},
"gather_table_schema": {
"example": true,
"title": "Gather metrics from INFORMATION_SCHEMA.TABLES",
"type": "boolean"
},
"perf_events_statements_digest_text_limit": {
"example": 120,
"maximum": 2048,
"minimum": 1,
"title": "Truncates digest text from perf_events_statements into this many characters",
"type": "integer"
},
"perf_events_statements_limit": {
"example": 250,
"maximum": 4000,
"minimum": 1,
"title": "Limits metrics from perf_events_statements",
"type": "integer"
},
"perf_events_statements_time_limit": {
"example": 86400,
"maximum": 2592000,
"minimum": 1,
"title": "Only include perf_events_statements whose last seen is less than this many seconds",
"type": "integer"
}
},
"title": "Configuration options for Telegraf MySQL input plugin",
"type": "object"
}
},
"title": "Configuration options for metrics where source service is MySQL",
"type": "object"
}
},
"title": "Integration user config",
"type": "object"
},
"read_replica": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"rsyslog": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
},
"signalfx": {
"additionalProperties": false,
"title": "Integration user config",
"type": "object"
}
}