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
|
{
"jsonSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Prometheus collector configuration.",
"type": "object",
"properties": {
"update_every": {
"title": "Update every",
"description": "Data collection interval, measured in seconds.",
"type": "integer",
"minimum": 1,
"default": 10
},
"url": {
"title": "URL",
"description": "The URL of the Prometheus metrics endpoint.",
"type": "string",
"format": "uri"
},
"timeout": {
"title": "Timeout",
"description": "The timeout in seconds for the HTTP request.",
"type": "number",
"minimum": 0.5,
"default": 10
},
"not_follow_redirects": {
"title": "Not follow redirects",
"description": "If set, the client will not follow HTTP redirects automatically.",
"type": "boolean"
},
"expected_prefix": {
"title": "Expected prefix",
"description": "If an endpoint does not return at least one metric with the specified prefix, the data is not processed.",
"type": "string"
},
"app": {
"title": "Application",
"description": "If set, this value will be used in the chart context as 'prometheus.{app}.{metric_name}'.",
"type": "string"
},
"selector": {
"title": "Selectors",
"description": "Configuration for selecting and filtering a set of time series using Prometheus selectors. If left empty, no filtering is applied.",
"type": [
"object",
"null"
],
"properties": {
"allow": {
"title": "Allow",
"description": "Allow time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/prometheus/selector#readme).",
"type": [
"array",
"null"
],
"items": {
"title": "Selector",
"type": "string"
},
"uniqueItems": true
},
"deny": {
"title": "Deny",
"description": "Deny time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/prometheus/selector#readme).",
"type": [
"array",
"null"
],
"items": {
"title": "Selector",
"type": "string"
},
"uniqueItems": true
}
}
},
"max_time_series": {
"title": "Time series limit",
"description": "If an endpoint returns more time series than this limit, the data is not processed. Set to 0 for no limit.",
"type": "integer",
"minimum": 0,
"default": 2000
},
"max_time_series_per_metric": {
"title": "Time series per metric limit",
"description": "Metrics with more time series than this limit are skipped. Set to 0 for no limit.",
"type": "integer",
"minimum": 0,
"default": 200
},
"fallback_type": {
"title": "Untyped metrics fallback",
"description": "Process Untyped metrics as Counter or Gauge instead of ignoring them.",
"type": [
"object",
"null"
],
"properties": {
"gauge": {
"title": "As Gauge",
"description": "Untyped metrics matching any [pattern](https://golang.org/pkg/path/filepath/#Match) will be processed as Gauge.",
"type": [
"array",
"null"
],
"items": {
"title": "Pattern",
"type": "string"
},
"uniqueItems": true
},
"Counter": {
"title": "As Counter",
"description": "Untyped metrics matching any [pattern](https://golang.org/pkg/path/filepath/#Match) will be processed as Counter.",
"type": [
"array",
"null"
],
"items": {
"title": "Pattern",
"type": "string"
},
"uniqueItems": true
}
}
},
"username": {
"title": "Username",
"description": "The username for basic authentication.",
"type": "string",
"sensitive": true
},
"password": {
"title": "Password",
"description": "The password for basic authentication.",
"type": "string",
"sensitive": true
},
"bearer_token_file": {
"title": "Bearer token file",
"description": "The path to the file with Bearer token.",
"type": "string"
},
"proxy_url": {
"title": "Proxy URL",
"description": "The URL of the proxy server.",
"type": "string"
},
"proxy_username": {
"title": "Proxy username",
"description": "The username for proxy authentication.",
"type": "string",
"sensitive": true
},
"proxy_password": {
"title": "Proxy password",
"description": "The password for proxy authentication.",
"type": "string",
"sensitive": true
},
"headers": {
"title": "Headers",
"description": "Additional HTTP headers to include in the request.",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"tls_skip_verify": {
"title": "Skip TLS verification",
"description": "If set, TLS certificate verification will be skipped.",
"type": "boolean"
},
"tls_ca": {
"title": "TLS CA",
"description": "The path to the CA certificate file for TLS verification.",
"type": "string",
"pattern": "^$|^/"
},
"tls_cert": {
"title": "TLS certificate",
"description": "The path to the client certificate file for TLS authentication.",
"type": "string",
"pattern": "^$|^/"
},
"tls_key": {
"title": "TLS key",
"description": "The path to the client key file for TLS authentication.",
"type": "string",
"pattern": "^$|^/"
}
},
"required": [
"url"
],
"additionalProperties": false,
"patternProperties": {
"^name$": {}
}
},
"uiSchema": {
"uiOptions": {
"fullPage": true
},
"ui:flavour": "tabs",
"ui:options": {
"tabs": [
{
"title": "Base",
"fields": [
"update_every",
"url",
"timeout",
"not_follow_redirects",
"expected_prefix",
"app"
]
},
{
"title": "Selectors",
"fields": [
"selector"
]
},
{
"title": "Limits",
"fields": [
"max_time_series",
"max_time_series_per_metric"
]
},
{
"title": "Untyped fallback",
"fields": [
"fallback_type"
]
},
{
"title": "Auth",
"fields": [
"username",
"password",
"bearer_token_file"
]
},
{
"title": "TLS",
"fields": [
"tls_skip_verify",
"tls_ca",
"tls_cert",
"tls_key"
]
},
{
"title": "Proxy",
"fields": [
"proxy_url",
"proxy_username",
"proxy_password"
]
},
{
"title": "Headers",
"fields": [
"headers"
]
}
]
},
"url": {
"ui:placeholder": "http://203.0.113.0"
},
"timeout": {
"ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
},
"selector": {
"ui:help": "The logic is as follows: `(allow1 OR allow2) AND !(deny1 OR deny2)`."
},
"password": {
"ui:widget": "password"
},
"proxy_password": {
"ui:widget": "password"
}
}
}
|
