@kong-ui-public/analytics-utilities 12.35.0 → 12.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types/dashboardSchema.v2.d.ts +872 -14
- package/dist/types/dashboardSchema.v2.d.ts.map +1 -1
- package/dist/vitals-utilities.cjs +1 -1
- package/dist/vitals-utilities.cjs.map +1 -1
- package/dist/vitals-utilities.es.js +906 -799
- package/dist/vitals-utilities.es.js.map +1 -1
- package/dist/vitals-utilities.umd.js +1 -1
- package/dist/vitals-utilities.umd.js.map +1 -1
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@ import type { FromSchema, JSONSchema } from 'json-schema-to-ts';
|
|
|
2
2
|
type FromSchemaWithOptions<T extends JSONSchema> = FromSchema<T, {
|
|
3
3
|
keepDefaultedPropertiesOptional: true;
|
|
4
4
|
}>;
|
|
5
|
-
export declare const dashboardTileTypes: readonly ["horizontal_bar", "vertical_bar", "gauge", "donut", "timeseries_line", "timeseries_bar", "golden_signals", "top_n", "table", "slottable", "single_value", "choropleth_map"];
|
|
5
|
+
export declare const dashboardTileTypes: readonly ["horizontal_bar", "vertical_bar", "gauge", "donut", "timeseries_line", "timeseries_bar", "scatter", "golden_signals", "top_n", "table", "slottable", "single_value", "choropleth_map"];
|
|
6
6
|
export type DashboardTileType = typeof dashboardTileTypes[number];
|
|
7
7
|
export declare const slottableSchema: {
|
|
8
8
|
readonly type: "object";
|
|
@@ -139,6 +139,118 @@ export declare const timeseriesChartSchema: {
|
|
|
139
139
|
readonly additionalProperties: false;
|
|
140
140
|
};
|
|
141
141
|
export type TimeseriesChartOptions = FromSchemaWithOptions<typeof timeseriesChartSchema>;
|
|
142
|
+
export declare const scatterPercentileLineSchema: {
|
|
143
|
+
readonly type: "object";
|
|
144
|
+
readonly properties: {
|
|
145
|
+
readonly percentile: {
|
|
146
|
+
readonly type: "number";
|
|
147
|
+
readonly minimum: 0;
|
|
148
|
+
readonly maximum: 100;
|
|
149
|
+
};
|
|
150
|
+
readonly label: {
|
|
151
|
+
readonly type: "string";
|
|
152
|
+
readonly description: "Overrides the default label.";
|
|
153
|
+
};
|
|
154
|
+
readonly border_dash: {
|
|
155
|
+
readonly type: "array";
|
|
156
|
+
readonly description: "Dash pattern for the line.";
|
|
157
|
+
readonly items: {
|
|
158
|
+
readonly type: "number";
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
readonly color: {
|
|
162
|
+
readonly type: "string";
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
readonly required: readonly ["percentile"];
|
|
166
|
+
readonly additionalProperties: false;
|
|
167
|
+
};
|
|
168
|
+
export declare const scatterChartSchema: {
|
|
169
|
+
readonly type: "object";
|
|
170
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
171
|
+
readonly properties: {
|
|
172
|
+
readonly type: {
|
|
173
|
+
readonly type: "string";
|
|
174
|
+
readonly enum: readonly ["scatter"];
|
|
175
|
+
};
|
|
176
|
+
readonly percentile_lines: {
|
|
177
|
+
readonly type: "array";
|
|
178
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
179
|
+
readonly items: {
|
|
180
|
+
readonly type: "object";
|
|
181
|
+
readonly properties: {
|
|
182
|
+
readonly percentile: {
|
|
183
|
+
readonly type: "number";
|
|
184
|
+
readonly minimum: 0;
|
|
185
|
+
readonly maximum: 100;
|
|
186
|
+
};
|
|
187
|
+
readonly label: {
|
|
188
|
+
readonly type: "string";
|
|
189
|
+
readonly description: "Overrides the default label.";
|
|
190
|
+
};
|
|
191
|
+
readonly border_dash: {
|
|
192
|
+
readonly type: "array";
|
|
193
|
+
readonly description: "Dash pattern for the line.";
|
|
194
|
+
readonly items: {
|
|
195
|
+
readonly type: "number";
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
readonly color: {
|
|
199
|
+
readonly type: "string";
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
readonly required: readonly ["percentile"];
|
|
203
|
+
readonly additionalProperties: false;
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
readonly outlier_percentile: {
|
|
207
|
+
readonly type: "number";
|
|
208
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
209
|
+
readonly minimum: 0;
|
|
210
|
+
readonly maximum: 100;
|
|
211
|
+
};
|
|
212
|
+
readonly shade_outlier_region: {
|
|
213
|
+
readonly type: "boolean";
|
|
214
|
+
readonly default: false;
|
|
215
|
+
};
|
|
216
|
+
readonly jitter_ms: {
|
|
217
|
+
readonly type: "number";
|
|
218
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
219
|
+
readonly minimum: 0;
|
|
220
|
+
};
|
|
221
|
+
readonly point_radius: {
|
|
222
|
+
readonly type: "number";
|
|
223
|
+
readonly minimum: 0;
|
|
224
|
+
};
|
|
225
|
+
readonly point_opacity: {
|
|
226
|
+
readonly type: "number";
|
|
227
|
+
readonly description: "Opacity of plotted points.";
|
|
228
|
+
readonly minimum: 0;
|
|
229
|
+
readonly maximum: 1;
|
|
230
|
+
};
|
|
231
|
+
readonly chart_dataset_colors: {
|
|
232
|
+
readonly type: readonly ["object", "array"];
|
|
233
|
+
readonly items: {
|
|
234
|
+
readonly type: "string";
|
|
235
|
+
};
|
|
236
|
+
readonly additionalProperties: {
|
|
237
|
+
readonly type: "string";
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
readonly synthetics_data_key: {
|
|
241
|
+
readonly type: "string";
|
|
242
|
+
};
|
|
243
|
+
readonly chart_title: {
|
|
244
|
+
readonly type: "string";
|
|
245
|
+
};
|
|
246
|
+
readonly allow_csv_export: {
|
|
247
|
+
readonly type: "boolean";
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
readonly required: readonly ["type"];
|
|
251
|
+
readonly additionalProperties: false;
|
|
252
|
+
};
|
|
253
|
+
export type ScatterChartOptions = FromSchemaWithOptions<typeof scatterChartSchema>;
|
|
142
254
|
export declare const gaugeChartSchema: {
|
|
143
255
|
readonly type: "object";
|
|
144
256
|
readonly properties: {
|
|
@@ -1167,6 +1279,121 @@ export declare const platformTabularQuerySchema: {
|
|
|
1167
1279
|
readonly required: readonly ["datasource"];
|
|
1168
1280
|
readonly additionalProperties: false;
|
|
1169
1281
|
};
|
|
1282
|
+
export declare const apiRequestsQuerySchema: {
|
|
1283
|
+
readonly type: "object";
|
|
1284
|
+
readonly description: "A query for the api-requests endpoint.";
|
|
1285
|
+
readonly properties: {
|
|
1286
|
+
readonly datasource: {
|
|
1287
|
+
readonly type: "string";
|
|
1288
|
+
readonly enum: readonly ["requests"];
|
|
1289
|
+
};
|
|
1290
|
+
readonly metric: {
|
|
1291
|
+
readonly type: "string";
|
|
1292
|
+
readonly description: "Field plotted on the y axis.";
|
|
1293
|
+
};
|
|
1294
|
+
readonly dimension: {
|
|
1295
|
+
readonly type: "string";
|
|
1296
|
+
readonly description: "Field used to split points into series.";
|
|
1297
|
+
};
|
|
1298
|
+
readonly filters: {
|
|
1299
|
+
readonly type: "array";
|
|
1300
|
+
readonly description: "A list of filters to apply to the query";
|
|
1301
|
+
readonly items: {
|
|
1302
|
+
readonly oneOf: readonly [{
|
|
1303
|
+
readonly type: "object";
|
|
1304
|
+
readonly description: "In filter";
|
|
1305
|
+
readonly properties: {
|
|
1306
|
+
readonly field: {
|
|
1307
|
+
readonly enum?: readonly string[] | undefined;
|
|
1308
|
+
readonly type: "string";
|
|
1309
|
+
};
|
|
1310
|
+
readonly operator: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly enum: readonly ["in", "not_in", "selector"];
|
|
1313
|
+
};
|
|
1314
|
+
readonly value: {
|
|
1315
|
+
readonly type: "array";
|
|
1316
|
+
readonly items: {
|
|
1317
|
+
readonly type: readonly ["string", "number", "null"];
|
|
1318
|
+
};
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
readonly required: readonly ["field", "operator", "value"];
|
|
1322
|
+
readonly additionalProperties: false;
|
|
1323
|
+
}, {
|
|
1324
|
+
readonly type: "object";
|
|
1325
|
+
readonly description: "Empty filter";
|
|
1326
|
+
readonly properties: {
|
|
1327
|
+
readonly field: {
|
|
1328
|
+
readonly enum?: readonly string[] | undefined;
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
};
|
|
1331
|
+
readonly operator: {
|
|
1332
|
+
readonly type: "string";
|
|
1333
|
+
readonly enum: readonly ["empty", "not_empty"];
|
|
1334
|
+
};
|
|
1335
|
+
};
|
|
1336
|
+
readonly required: readonly ["field", "operator"];
|
|
1337
|
+
readonly additionalProperties: false;
|
|
1338
|
+
}];
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
readonly time_range: {
|
|
1342
|
+
readonly type: "object";
|
|
1343
|
+
readonly description: "The time range to query.";
|
|
1344
|
+
readonly anyOf: readonly [{
|
|
1345
|
+
readonly type: "object";
|
|
1346
|
+
readonly properties: {
|
|
1347
|
+
readonly tz: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly default: "Etc/UTC";
|
|
1350
|
+
};
|
|
1351
|
+
readonly type: {
|
|
1352
|
+
readonly type: "string";
|
|
1353
|
+
readonly enum: readonly ["relative"];
|
|
1354
|
+
};
|
|
1355
|
+
readonly time_range: {
|
|
1356
|
+
readonly type: "string";
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
readonly required: readonly ["type", "time_range"];
|
|
1360
|
+
readonly additionalProperties: false;
|
|
1361
|
+
}, {
|
|
1362
|
+
readonly type: "object";
|
|
1363
|
+
readonly description: "A duration representing an exact start and end time.";
|
|
1364
|
+
readonly properties: {
|
|
1365
|
+
readonly tz: {
|
|
1366
|
+
readonly type: "string";
|
|
1367
|
+
};
|
|
1368
|
+
readonly type: {
|
|
1369
|
+
readonly type: "string";
|
|
1370
|
+
readonly enum: readonly ["absolute"];
|
|
1371
|
+
};
|
|
1372
|
+
readonly start: {
|
|
1373
|
+
readonly type: "string";
|
|
1374
|
+
};
|
|
1375
|
+
readonly end: {
|
|
1376
|
+
readonly type: "string";
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
readonly required: readonly ["type", "start", "end"];
|
|
1380
|
+
readonly additionalProperties: false;
|
|
1381
|
+
}];
|
|
1382
|
+
readonly default: {
|
|
1383
|
+
readonly type: "relative";
|
|
1384
|
+
readonly time_range: "1h";
|
|
1385
|
+
};
|
|
1386
|
+
};
|
|
1387
|
+
readonly max_records: {
|
|
1388
|
+
readonly type: "number";
|
|
1389
|
+
readonly description: "Ceiling on records gathered across pages. The endpoint serves at most 1000 per page. Defaults to 10000.";
|
|
1390
|
+
readonly minimum: 1;
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
readonly required: readonly ["datasource", "metric"];
|
|
1394
|
+
readonly additionalProperties: false;
|
|
1395
|
+
};
|
|
1396
|
+
export type ApiRequestsQuery = FromSchemaWithOptions<typeof apiRequestsQuerySchema>;
|
|
1170
1397
|
export declare const validDashboardChartQuery: {
|
|
1171
1398
|
readonly anyOf: readonly [{
|
|
1172
1399
|
readonly type: "object";
|
|
@@ -3784,6 +4011,90 @@ declare const chartTileDefinitionSchema: {
|
|
|
3784
4011
|
};
|
|
3785
4012
|
readonly required: readonly ["type"];
|
|
3786
4013
|
readonly additionalProperties: false;
|
|
4014
|
+
}, {
|
|
4015
|
+
readonly type: "object";
|
|
4016
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
4017
|
+
readonly properties: {
|
|
4018
|
+
readonly type: {
|
|
4019
|
+
readonly type: "string";
|
|
4020
|
+
readonly enum: readonly ["scatter"];
|
|
4021
|
+
};
|
|
4022
|
+
readonly percentile_lines: {
|
|
4023
|
+
readonly type: "array";
|
|
4024
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
4025
|
+
readonly items: {
|
|
4026
|
+
readonly type: "object";
|
|
4027
|
+
readonly properties: {
|
|
4028
|
+
readonly percentile: {
|
|
4029
|
+
readonly type: "number";
|
|
4030
|
+
readonly minimum: 0;
|
|
4031
|
+
readonly maximum: 100;
|
|
4032
|
+
};
|
|
4033
|
+
readonly label: {
|
|
4034
|
+
readonly type: "string";
|
|
4035
|
+
readonly description: "Overrides the default label.";
|
|
4036
|
+
};
|
|
4037
|
+
readonly border_dash: {
|
|
4038
|
+
readonly type: "array";
|
|
4039
|
+
readonly description: "Dash pattern for the line.";
|
|
4040
|
+
readonly items: {
|
|
4041
|
+
readonly type: "number";
|
|
4042
|
+
};
|
|
4043
|
+
};
|
|
4044
|
+
readonly color: {
|
|
4045
|
+
readonly type: "string";
|
|
4046
|
+
};
|
|
4047
|
+
};
|
|
4048
|
+
readonly required: readonly ["percentile"];
|
|
4049
|
+
readonly additionalProperties: false;
|
|
4050
|
+
};
|
|
4051
|
+
};
|
|
4052
|
+
readonly outlier_percentile: {
|
|
4053
|
+
readonly type: "number";
|
|
4054
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
4055
|
+
readonly minimum: 0;
|
|
4056
|
+
readonly maximum: 100;
|
|
4057
|
+
};
|
|
4058
|
+
readonly shade_outlier_region: {
|
|
4059
|
+
readonly type: "boolean";
|
|
4060
|
+
readonly default: false;
|
|
4061
|
+
};
|
|
4062
|
+
readonly jitter_ms: {
|
|
4063
|
+
readonly type: "number";
|
|
4064
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
4065
|
+
readonly minimum: 0;
|
|
4066
|
+
};
|
|
4067
|
+
readonly point_radius: {
|
|
4068
|
+
readonly type: "number";
|
|
4069
|
+
readonly minimum: 0;
|
|
4070
|
+
};
|
|
4071
|
+
readonly point_opacity: {
|
|
4072
|
+
readonly type: "number";
|
|
4073
|
+
readonly description: "Opacity of plotted points.";
|
|
4074
|
+
readonly minimum: 0;
|
|
4075
|
+
readonly maximum: 1;
|
|
4076
|
+
};
|
|
4077
|
+
readonly chart_dataset_colors: {
|
|
4078
|
+
readonly type: readonly ["object", "array"];
|
|
4079
|
+
readonly items: {
|
|
4080
|
+
readonly type: "string";
|
|
4081
|
+
};
|
|
4082
|
+
readonly additionalProperties: {
|
|
4083
|
+
readonly type: "string";
|
|
4084
|
+
};
|
|
4085
|
+
};
|
|
4086
|
+
readonly synthetics_data_key: {
|
|
4087
|
+
readonly type: "string";
|
|
4088
|
+
};
|
|
4089
|
+
readonly chart_title: {
|
|
4090
|
+
readonly type: "string";
|
|
4091
|
+
};
|
|
4092
|
+
readonly allow_csv_export: {
|
|
4093
|
+
readonly type: "boolean";
|
|
4094
|
+
};
|
|
4095
|
+
};
|
|
4096
|
+
readonly required: readonly ["type"];
|
|
4097
|
+
readonly additionalProperties: false;
|
|
3787
4098
|
}, {
|
|
3788
4099
|
readonly type: "object";
|
|
3789
4100
|
readonly properties: {
|
|
@@ -3981,27 +4292,238 @@ declare const tableChartTileDefinitionSchema: {
|
|
|
3981
4292
|
}];
|
|
3982
4293
|
};
|
|
3983
4294
|
};
|
|
3984
|
-
readonly cursor: {
|
|
4295
|
+
readonly cursor: {
|
|
4296
|
+
readonly type: "string";
|
|
4297
|
+
};
|
|
4298
|
+
readonly page_size: {
|
|
4299
|
+
readonly type: "number";
|
|
4300
|
+
};
|
|
4301
|
+
};
|
|
4302
|
+
readonly required: readonly ["datasource"];
|
|
4303
|
+
readonly additionalProperties: false;
|
|
4304
|
+
}];
|
|
4305
|
+
};
|
|
4306
|
+
readonly chart: {
|
|
4307
|
+
readonly type: "object";
|
|
4308
|
+
readonly properties: {
|
|
4309
|
+
readonly type: {
|
|
4310
|
+
readonly type: "string";
|
|
4311
|
+
readonly enum: readonly ["table"];
|
|
4312
|
+
};
|
|
4313
|
+
readonly chart_title: {
|
|
4314
|
+
readonly type: "string";
|
|
4315
|
+
};
|
|
4316
|
+
};
|
|
4317
|
+
readonly required: readonly ["type"];
|
|
4318
|
+
readonly additionalProperties: false;
|
|
4319
|
+
};
|
|
4320
|
+
readonly header_description: {
|
|
4321
|
+
readonly type: "string";
|
|
4322
|
+
readonly description: "Text rendered in the tile header. Supports the {timeframe} token, ";
|
|
4323
|
+
};
|
|
4324
|
+
};
|
|
4325
|
+
readonly required: readonly ["query", "chart"];
|
|
4326
|
+
readonly additionalProperties: false;
|
|
4327
|
+
};
|
|
4328
|
+
export type TableChartTileDefinition = FromSchemaWithOptions<typeof tableChartTileDefinitionSchema>;
|
|
4329
|
+
declare const scatterTileDefinitionSchema: {
|
|
4330
|
+
readonly type: "object";
|
|
4331
|
+
readonly properties: {
|
|
4332
|
+
readonly query: {
|
|
4333
|
+
readonly type: "object";
|
|
4334
|
+
readonly description: "A query for the api-requests endpoint.";
|
|
4335
|
+
readonly properties: {
|
|
4336
|
+
readonly datasource: {
|
|
4337
|
+
readonly type: "string";
|
|
4338
|
+
readonly enum: readonly ["requests"];
|
|
4339
|
+
};
|
|
4340
|
+
readonly metric: {
|
|
4341
|
+
readonly type: "string";
|
|
4342
|
+
readonly description: "Field plotted on the y axis.";
|
|
4343
|
+
};
|
|
4344
|
+
readonly dimension: {
|
|
4345
|
+
readonly type: "string";
|
|
4346
|
+
readonly description: "Field used to split points into series.";
|
|
4347
|
+
};
|
|
4348
|
+
readonly filters: {
|
|
4349
|
+
readonly type: "array";
|
|
4350
|
+
readonly description: "A list of filters to apply to the query";
|
|
4351
|
+
readonly items: {
|
|
4352
|
+
readonly oneOf: readonly [{
|
|
4353
|
+
readonly type: "object";
|
|
4354
|
+
readonly description: "In filter";
|
|
4355
|
+
readonly properties: {
|
|
4356
|
+
readonly field: {
|
|
4357
|
+
readonly enum?: readonly string[] | undefined;
|
|
4358
|
+
readonly type: "string";
|
|
4359
|
+
};
|
|
4360
|
+
readonly operator: {
|
|
4361
|
+
readonly type: "string";
|
|
4362
|
+
readonly enum: readonly ["in", "not_in", "selector"];
|
|
4363
|
+
};
|
|
4364
|
+
readonly value: {
|
|
4365
|
+
readonly type: "array";
|
|
4366
|
+
readonly items: {
|
|
4367
|
+
readonly type: readonly ["string", "number", "null"];
|
|
4368
|
+
};
|
|
4369
|
+
};
|
|
4370
|
+
};
|
|
4371
|
+
readonly required: readonly ["field", "operator", "value"];
|
|
4372
|
+
readonly additionalProperties: false;
|
|
4373
|
+
}, {
|
|
4374
|
+
readonly type: "object";
|
|
4375
|
+
readonly description: "Empty filter";
|
|
4376
|
+
readonly properties: {
|
|
4377
|
+
readonly field: {
|
|
4378
|
+
readonly enum?: readonly string[] | undefined;
|
|
4379
|
+
readonly type: "string";
|
|
4380
|
+
};
|
|
4381
|
+
readonly operator: {
|
|
4382
|
+
readonly type: "string";
|
|
4383
|
+
readonly enum: readonly ["empty", "not_empty"];
|
|
4384
|
+
};
|
|
4385
|
+
};
|
|
4386
|
+
readonly required: readonly ["field", "operator"];
|
|
4387
|
+
readonly additionalProperties: false;
|
|
4388
|
+
}];
|
|
4389
|
+
};
|
|
4390
|
+
};
|
|
4391
|
+
readonly time_range: {
|
|
4392
|
+
readonly type: "object";
|
|
4393
|
+
readonly description: "The time range to query.";
|
|
4394
|
+
readonly anyOf: readonly [{
|
|
4395
|
+
readonly type: "object";
|
|
4396
|
+
readonly properties: {
|
|
4397
|
+
readonly tz: {
|
|
4398
|
+
readonly type: "string";
|
|
4399
|
+
readonly default: "Etc/UTC";
|
|
4400
|
+
};
|
|
4401
|
+
readonly type: {
|
|
4402
|
+
readonly type: "string";
|
|
4403
|
+
readonly enum: readonly ["relative"];
|
|
4404
|
+
};
|
|
4405
|
+
readonly time_range: {
|
|
4406
|
+
readonly type: "string";
|
|
4407
|
+
};
|
|
4408
|
+
};
|
|
4409
|
+
readonly required: readonly ["type", "time_range"];
|
|
4410
|
+
readonly additionalProperties: false;
|
|
4411
|
+
}, {
|
|
4412
|
+
readonly type: "object";
|
|
4413
|
+
readonly description: "A duration representing an exact start and end time.";
|
|
4414
|
+
readonly properties: {
|
|
4415
|
+
readonly tz: {
|
|
4416
|
+
readonly type: "string";
|
|
4417
|
+
};
|
|
4418
|
+
readonly type: {
|
|
4419
|
+
readonly type: "string";
|
|
4420
|
+
readonly enum: readonly ["absolute"];
|
|
4421
|
+
};
|
|
4422
|
+
readonly start: {
|
|
4423
|
+
readonly type: "string";
|
|
4424
|
+
};
|
|
4425
|
+
readonly end: {
|
|
4426
|
+
readonly type: "string";
|
|
4427
|
+
};
|
|
4428
|
+
};
|
|
4429
|
+
readonly required: readonly ["type", "start", "end"];
|
|
4430
|
+
readonly additionalProperties: false;
|
|
4431
|
+
}];
|
|
4432
|
+
readonly default: {
|
|
4433
|
+
readonly type: "relative";
|
|
4434
|
+
readonly time_range: "1h";
|
|
4435
|
+
};
|
|
4436
|
+
};
|
|
4437
|
+
readonly max_records: {
|
|
4438
|
+
readonly type: "number";
|
|
4439
|
+
readonly description: "Ceiling on records gathered across pages. The endpoint serves at most 1000 per page. Defaults to 10000.";
|
|
4440
|
+
readonly minimum: 1;
|
|
4441
|
+
};
|
|
4442
|
+
};
|
|
4443
|
+
readonly required: readonly ["datasource", "metric"];
|
|
4444
|
+
readonly additionalProperties: false;
|
|
4445
|
+
};
|
|
4446
|
+
readonly chart: {
|
|
4447
|
+
readonly type: "object";
|
|
4448
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
4449
|
+
readonly properties: {
|
|
4450
|
+
readonly type: {
|
|
4451
|
+
readonly type: "string";
|
|
4452
|
+
readonly enum: readonly ["scatter"];
|
|
4453
|
+
};
|
|
4454
|
+
readonly percentile_lines: {
|
|
4455
|
+
readonly type: "array";
|
|
4456
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
4457
|
+
readonly items: {
|
|
4458
|
+
readonly type: "object";
|
|
4459
|
+
readonly properties: {
|
|
4460
|
+
readonly percentile: {
|
|
4461
|
+
readonly type: "number";
|
|
4462
|
+
readonly minimum: 0;
|
|
4463
|
+
readonly maximum: 100;
|
|
4464
|
+
};
|
|
4465
|
+
readonly label: {
|
|
4466
|
+
readonly type: "string";
|
|
4467
|
+
readonly description: "Overrides the default label.";
|
|
4468
|
+
};
|
|
4469
|
+
readonly border_dash: {
|
|
4470
|
+
readonly type: "array";
|
|
4471
|
+
readonly description: "Dash pattern for the line.";
|
|
4472
|
+
readonly items: {
|
|
4473
|
+
readonly type: "number";
|
|
4474
|
+
};
|
|
4475
|
+
};
|
|
4476
|
+
readonly color: {
|
|
4477
|
+
readonly type: "string";
|
|
4478
|
+
};
|
|
4479
|
+
};
|
|
4480
|
+
readonly required: readonly ["percentile"];
|
|
4481
|
+
readonly additionalProperties: false;
|
|
4482
|
+
};
|
|
4483
|
+
};
|
|
4484
|
+
readonly outlier_percentile: {
|
|
4485
|
+
readonly type: "number";
|
|
4486
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
4487
|
+
readonly minimum: 0;
|
|
4488
|
+
readonly maximum: 100;
|
|
4489
|
+
};
|
|
4490
|
+
readonly shade_outlier_region: {
|
|
4491
|
+
readonly type: "boolean";
|
|
4492
|
+
readonly default: false;
|
|
4493
|
+
};
|
|
4494
|
+
readonly jitter_ms: {
|
|
4495
|
+
readonly type: "number";
|
|
4496
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
4497
|
+
readonly minimum: 0;
|
|
4498
|
+
};
|
|
4499
|
+
readonly point_radius: {
|
|
4500
|
+
readonly type: "number";
|
|
4501
|
+
readonly minimum: 0;
|
|
4502
|
+
};
|
|
4503
|
+
readonly point_opacity: {
|
|
4504
|
+
readonly type: "number";
|
|
4505
|
+
readonly description: "Opacity of plotted points.";
|
|
4506
|
+
readonly minimum: 0;
|
|
4507
|
+
readonly maximum: 1;
|
|
4508
|
+
};
|
|
4509
|
+
readonly chart_dataset_colors: {
|
|
4510
|
+
readonly type: readonly ["object", "array"];
|
|
4511
|
+
readonly items: {
|
|
3985
4512
|
readonly type: "string";
|
|
3986
4513
|
};
|
|
3987
|
-
readonly
|
|
3988
|
-
readonly type: "
|
|
4514
|
+
readonly additionalProperties: {
|
|
4515
|
+
readonly type: "string";
|
|
3989
4516
|
};
|
|
3990
4517
|
};
|
|
3991
|
-
readonly
|
|
3992
|
-
readonly additionalProperties: false;
|
|
3993
|
-
}];
|
|
3994
|
-
};
|
|
3995
|
-
readonly chart: {
|
|
3996
|
-
readonly type: "object";
|
|
3997
|
-
readonly properties: {
|
|
3998
|
-
readonly type: {
|
|
4518
|
+
readonly synthetics_data_key: {
|
|
3999
4519
|
readonly type: "string";
|
|
4000
|
-
readonly enum: readonly ["table"];
|
|
4001
4520
|
};
|
|
4002
4521
|
readonly chart_title: {
|
|
4003
4522
|
readonly type: "string";
|
|
4004
4523
|
};
|
|
4524
|
+
readonly allow_csv_export: {
|
|
4525
|
+
readonly type: "boolean";
|
|
4526
|
+
};
|
|
4005
4527
|
};
|
|
4006
4528
|
readonly required: readonly ["type"];
|
|
4007
4529
|
readonly additionalProperties: false;
|
|
@@ -4014,7 +4536,7 @@ declare const tableChartTileDefinitionSchema: {
|
|
|
4014
4536
|
readonly required: readonly ["query", "chart"];
|
|
4015
4537
|
readonly additionalProperties: false;
|
|
4016
4538
|
};
|
|
4017
|
-
export type
|
|
4539
|
+
export type ScatterTileDefinition = FromSchemaWithOptions<typeof scatterTileDefinitionSchema>;
|
|
4018
4540
|
export declare const tileDefinitionSchema: {
|
|
4019
4541
|
readonly anyOf: readonly [{
|
|
4020
4542
|
readonly type: "object";
|
|
@@ -4929,6 +5451,90 @@ export declare const tileDefinitionSchema: {
|
|
|
4929
5451
|
};
|
|
4930
5452
|
readonly required: readonly ["type"];
|
|
4931
5453
|
readonly additionalProperties: false;
|
|
5454
|
+
}, {
|
|
5455
|
+
readonly type: "object";
|
|
5456
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
5457
|
+
readonly properties: {
|
|
5458
|
+
readonly type: {
|
|
5459
|
+
readonly type: "string";
|
|
5460
|
+
readonly enum: readonly ["scatter"];
|
|
5461
|
+
};
|
|
5462
|
+
readonly percentile_lines: {
|
|
5463
|
+
readonly type: "array";
|
|
5464
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
5465
|
+
readonly items: {
|
|
5466
|
+
readonly type: "object";
|
|
5467
|
+
readonly properties: {
|
|
5468
|
+
readonly percentile: {
|
|
5469
|
+
readonly type: "number";
|
|
5470
|
+
readonly minimum: 0;
|
|
5471
|
+
readonly maximum: 100;
|
|
5472
|
+
};
|
|
5473
|
+
readonly label: {
|
|
5474
|
+
readonly type: "string";
|
|
5475
|
+
readonly description: "Overrides the default label.";
|
|
5476
|
+
};
|
|
5477
|
+
readonly border_dash: {
|
|
5478
|
+
readonly type: "array";
|
|
5479
|
+
readonly description: "Dash pattern for the line.";
|
|
5480
|
+
readonly items: {
|
|
5481
|
+
readonly type: "number";
|
|
5482
|
+
};
|
|
5483
|
+
};
|
|
5484
|
+
readonly color: {
|
|
5485
|
+
readonly type: "string";
|
|
5486
|
+
};
|
|
5487
|
+
};
|
|
5488
|
+
readonly required: readonly ["percentile"];
|
|
5489
|
+
readonly additionalProperties: false;
|
|
5490
|
+
};
|
|
5491
|
+
};
|
|
5492
|
+
readonly outlier_percentile: {
|
|
5493
|
+
readonly type: "number";
|
|
5494
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
5495
|
+
readonly minimum: 0;
|
|
5496
|
+
readonly maximum: 100;
|
|
5497
|
+
};
|
|
5498
|
+
readonly shade_outlier_region: {
|
|
5499
|
+
readonly type: "boolean";
|
|
5500
|
+
readonly default: false;
|
|
5501
|
+
};
|
|
5502
|
+
readonly jitter_ms: {
|
|
5503
|
+
readonly type: "number";
|
|
5504
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
5505
|
+
readonly minimum: 0;
|
|
5506
|
+
};
|
|
5507
|
+
readonly point_radius: {
|
|
5508
|
+
readonly type: "number";
|
|
5509
|
+
readonly minimum: 0;
|
|
5510
|
+
};
|
|
5511
|
+
readonly point_opacity: {
|
|
5512
|
+
readonly type: "number";
|
|
5513
|
+
readonly description: "Opacity of plotted points.";
|
|
5514
|
+
readonly minimum: 0;
|
|
5515
|
+
readonly maximum: 1;
|
|
5516
|
+
};
|
|
5517
|
+
readonly chart_dataset_colors: {
|
|
5518
|
+
readonly type: readonly ["object", "array"];
|
|
5519
|
+
readonly items: {
|
|
5520
|
+
readonly type: "string";
|
|
5521
|
+
};
|
|
5522
|
+
readonly additionalProperties: {
|
|
5523
|
+
readonly type: "string";
|
|
5524
|
+
};
|
|
5525
|
+
};
|
|
5526
|
+
readonly synthetics_data_key: {
|
|
5527
|
+
readonly type: "string";
|
|
5528
|
+
};
|
|
5529
|
+
readonly chart_title: {
|
|
5530
|
+
readonly type: "string";
|
|
5531
|
+
};
|
|
5532
|
+
readonly allow_csv_export: {
|
|
5533
|
+
readonly type: "boolean";
|
|
5534
|
+
};
|
|
5535
|
+
};
|
|
5536
|
+
readonly required: readonly ["type"];
|
|
5537
|
+
readonly additionalProperties: false;
|
|
4932
5538
|
}, {
|
|
4933
5539
|
readonly type: "object";
|
|
4934
5540
|
readonly properties: {
|
|
@@ -6119,6 +6725,90 @@ export declare const chartTileConfigSchema: {
|
|
|
6119
6725
|
};
|
|
6120
6726
|
readonly required: readonly ["type"];
|
|
6121
6727
|
readonly additionalProperties: false;
|
|
6728
|
+
}, {
|
|
6729
|
+
readonly type: "object";
|
|
6730
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
6731
|
+
readonly properties: {
|
|
6732
|
+
readonly type: {
|
|
6733
|
+
readonly type: "string";
|
|
6734
|
+
readonly enum: readonly ["scatter"];
|
|
6735
|
+
};
|
|
6736
|
+
readonly percentile_lines: {
|
|
6737
|
+
readonly type: "array";
|
|
6738
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
6739
|
+
readonly items: {
|
|
6740
|
+
readonly type: "object";
|
|
6741
|
+
readonly properties: {
|
|
6742
|
+
readonly percentile: {
|
|
6743
|
+
readonly type: "number";
|
|
6744
|
+
readonly minimum: 0;
|
|
6745
|
+
readonly maximum: 100;
|
|
6746
|
+
};
|
|
6747
|
+
readonly label: {
|
|
6748
|
+
readonly type: "string";
|
|
6749
|
+
readonly description: "Overrides the default label.";
|
|
6750
|
+
};
|
|
6751
|
+
readonly border_dash: {
|
|
6752
|
+
readonly type: "array";
|
|
6753
|
+
readonly description: "Dash pattern for the line.";
|
|
6754
|
+
readonly items: {
|
|
6755
|
+
readonly type: "number";
|
|
6756
|
+
};
|
|
6757
|
+
};
|
|
6758
|
+
readonly color: {
|
|
6759
|
+
readonly type: "string";
|
|
6760
|
+
};
|
|
6761
|
+
};
|
|
6762
|
+
readonly required: readonly ["percentile"];
|
|
6763
|
+
readonly additionalProperties: false;
|
|
6764
|
+
};
|
|
6765
|
+
};
|
|
6766
|
+
readonly outlier_percentile: {
|
|
6767
|
+
readonly type: "number";
|
|
6768
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
6769
|
+
readonly minimum: 0;
|
|
6770
|
+
readonly maximum: 100;
|
|
6771
|
+
};
|
|
6772
|
+
readonly shade_outlier_region: {
|
|
6773
|
+
readonly type: "boolean";
|
|
6774
|
+
readonly default: false;
|
|
6775
|
+
};
|
|
6776
|
+
readonly jitter_ms: {
|
|
6777
|
+
readonly type: "number";
|
|
6778
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
6779
|
+
readonly minimum: 0;
|
|
6780
|
+
};
|
|
6781
|
+
readonly point_radius: {
|
|
6782
|
+
readonly type: "number";
|
|
6783
|
+
readonly minimum: 0;
|
|
6784
|
+
};
|
|
6785
|
+
readonly point_opacity: {
|
|
6786
|
+
readonly type: "number";
|
|
6787
|
+
readonly description: "Opacity of plotted points.";
|
|
6788
|
+
readonly minimum: 0;
|
|
6789
|
+
readonly maximum: 1;
|
|
6790
|
+
};
|
|
6791
|
+
readonly chart_dataset_colors: {
|
|
6792
|
+
readonly type: readonly ["object", "array"];
|
|
6793
|
+
readonly items: {
|
|
6794
|
+
readonly type: "string";
|
|
6795
|
+
};
|
|
6796
|
+
readonly additionalProperties: {
|
|
6797
|
+
readonly type: "string";
|
|
6798
|
+
};
|
|
6799
|
+
};
|
|
6800
|
+
readonly synthetics_data_key: {
|
|
6801
|
+
readonly type: "string";
|
|
6802
|
+
};
|
|
6803
|
+
readonly chart_title: {
|
|
6804
|
+
readonly type: "string";
|
|
6805
|
+
};
|
|
6806
|
+
readonly allow_csv_export: {
|
|
6807
|
+
readonly type: "boolean";
|
|
6808
|
+
};
|
|
6809
|
+
};
|
|
6810
|
+
readonly required: readonly ["type"];
|
|
6811
|
+
readonly additionalProperties: false;
|
|
6122
6812
|
}, {
|
|
6123
6813
|
readonly type: "object";
|
|
6124
6814
|
readonly properties: {
|
|
@@ -7372,6 +8062,90 @@ export declare const tileConfigSchema: {
|
|
|
7372
8062
|
};
|
|
7373
8063
|
readonly required: readonly ["type"];
|
|
7374
8064
|
readonly additionalProperties: false;
|
|
8065
|
+
}, {
|
|
8066
|
+
readonly type: "object";
|
|
8067
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
8068
|
+
readonly properties: {
|
|
8069
|
+
readonly type: {
|
|
8070
|
+
readonly type: "string";
|
|
8071
|
+
readonly enum: readonly ["scatter"];
|
|
8072
|
+
};
|
|
8073
|
+
readonly percentile_lines: {
|
|
8074
|
+
readonly type: "array";
|
|
8075
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
8076
|
+
readonly items: {
|
|
8077
|
+
readonly type: "object";
|
|
8078
|
+
readonly properties: {
|
|
8079
|
+
readonly percentile: {
|
|
8080
|
+
readonly type: "number";
|
|
8081
|
+
readonly minimum: 0;
|
|
8082
|
+
readonly maximum: 100;
|
|
8083
|
+
};
|
|
8084
|
+
readonly label: {
|
|
8085
|
+
readonly type: "string";
|
|
8086
|
+
readonly description: "Overrides the default label.";
|
|
8087
|
+
};
|
|
8088
|
+
readonly border_dash: {
|
|
8089
|
+
readonly type: "array";
|
|
8090
|
+
readonly description: "Dash pattern for the line.";
|
|
8091
|
+
readonly items: {
|
|
8092
|
+
readonly type: "number";
|
|
8093
|
+
};
|
|
8094
|
+
};
|
|
8095
|
+
readonly color: {
|
|
8096
|
+
readonly type: "string";
|
|
8097
|
+
};
|
|
8098
|
+
};
|
|
8099
|
+
readonly required: readonly ["percentile"];
|
|
8100
|
+
readonly additionalProperties: false;
|
|
8101
|
+
};
|
|
8102
|
+
};
|
|
8103
|
+
readonly outlier_percentile: {
|
|
8104
|
+
readonly type: "number";
|
|
8105
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
8106
|
+
readonly minimum: 0;
|
|
8107
|
+
readonly maximum: 100;
|
|
8108
|
+
};
|
|
8109
|
+
readonly shade_outlier_region: {
|
|
8110
|
+
readonly type: "boolean";
|
|
8111
|
+
readonly default: false;
|
|
8112
|
+
};
|
|
8113
|
+
readonly jitter_ms: {
|
|
8114
|
+
readonly type: "number";
|
|
8115
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
8116
|
+
readonly minimum: 0;
|
|
8117
|
+
};
|
|
8118
|
+
readonly point_radius: {
|
|
8119
|
+
readonly type: "number";
|
|
8120
|
+
readonly minimum: 0;
|
|
8121
|
+
};
|
|
8122
|
+
readonly point_opacity: {
|
|
8123
|
+
readonly type: "number";
|
|
8124
|
+
readonly description: "Opacity of plotted points.";
|
|
8125
|
+
readonly minimum: 0;
|
|
8126
|
+
readonly maximum: 1;
|
|
8127
|
+
};
|
|
8128
|
+
readonly chart_dataset_colors: {
|
|
8129
|
+
readonly type: readonly ["object", "array"];
|
|
8130
|
+
readonly items: {
|
|
8131
|
+
readonly type: "string";
|
|
8132
|
+
};
|
|
8133
|
+
readonly additionalProperties: {
|
|
8134
|
+
readonly type: "string";
|
|
8135
|
+
};
|
|
8136
|
+
};
|
|
8137
|
+
readonly synthetics_data_key: {
|
|
8138
|
+
readonly type: "string";
|
|
8139
|
+
};
|
|
8140
|
+
readonly chart_title: {
|
|
8141
|
+
readonly type: "string";
|
|
8142
|
+
};
|
|
8143
|
+
readonly allow_csv_export: {
|
|
8144
|
+
readonly type: "boolean";
|
|
8145
|
+
};
|
|
8146
|
+
};
|
|
8147
|
+
readonly required: readonly ["type"];
|
|
8148
|
+
readonly additionalProperties: false;
|
|
7375
8149
|
}, {
|
|
7376
8150
|
readonly type: "object";
|
|
7377
8151
|
readonly properties: {
|
|
@@ -8629,6 +9403,90 @@ export declare const dashboardConfigSchema: {
|
|
|
8629
9403
|
};
|
|
8630
9404
|
readonly required: readonly ["type"];
|
|
8631
9405
|
readonly additionalProperties: false;
|
|
9406
|
+
}, {
|
|
9407
|
+
readonly type: "object";
|
|
9408
|
+
readonly description: "Plots one point per record, percentiles are computed from the records returned.";
|
|
9409
|
+
readonly properties: {
|
|
9410
|
+
readonly type: {
|
|
9411
|
+
readonly type: "string";
|
|
9412
|
+
readonly enum: readonly ["scatter"];
|
|
9413
|
+
};
|
|
9414
|
+
readonly percentile_lines: {
|
|
9415
|
+
readonly type: "array";
|
|
9416
|
+
readonly description: "Reference lines derived from the plotted values.";
|
|
9417
|
+
readonly items: {
|
|
9418
|
+
readonly type: "object";
|
|
9419
|
+
readonly properties: {
|
|
9420
|
+
readonly percentile: {
|
|
9421
|
+
readonly type: "number";
|
|
9422
|
+
readonly minimum: 0;
|
|
9423
|
+
readonly maximum: 100;
|
|
9424
|
+
};
|
|
9425
|
+
readonly label: {
|
|
9426
|
+
readonly type: "string";
|
|
9427
|
+
readonly description: "Overrides the default label.";
|
|
9428
|
+
};
|
|
9429
|
+
readonly border_dash: {
|
|
9430
|
+
readonly type: "array";
|
|
9431
|
+
readonly description: "Dash pattern for the line.";
|
|
9432
|
+
readonly items: {
|
|
9433
|
+
readonly type: "number";
|
|
9434
|
+
};
|
|
9435
|
+
};
|
|
9436
|
+
readonly color: {
|
|
9437
|
+
readonly type: "string";
|
|
9438
|
+
};
|
|
9439
|
+
};
|
|
9440
|
+
readonly required: readonly ["percentile"];
|
|
9441
|
+
readonly additionalProperties: false;
|
|
9442
|
+
};
|
|
9443
|
+
};
|
|
9444
|
+
readonly outlier_percentile: {
|
|
9445
|
+
readonly type: "number";
|
|
9446
|
+
readonly description: "Percentile above which points are split into a highlighted outlier series.";
|
|
9447
|
+
readonly minimum: 0;
|
|
9448
|
+
readonly maximum: 100;
|
|
9449
|
+
};
|
|
9450
|
+
readonly shade_outlier_region: {
|
|
9451
|
+
readonly type: "boolean";
|
|
9452
|
+
readonly default: false;
|
|
9453
|
+
};
|
|
9454
|
+
readonly jitter_ms: {
|
|
9455
|
+
readonly type: "number";
|
|
9456
|
+
readonly description: "Maximum horizontal jitter so records sharing a timestamp do not stack into one column.";
|
|
9457
|
+
readonly minimum: 0;
|
|
9458
|
+
};
|
|
9459
|
+
readonly point_radius: {
|
|
9460
|
+
readonly type: "number";
|
|
9461
|
+
readonly minimum: 0;
|
|
9462
|
+
};
|
|
9463
|
+
readonly point_opacity: {
|
|
9464
|
+
readonly type: "number";
|
|
9465
|
+
readonly description: "Opacity of plotted points.";
|
|
9466
|
+
readonly minimum: 0;
|
|
9467
|
+
readonly maximum: 1;
|
|
9468
|
+
};
|
|
9469
|
+
readonly chart_dataset_colors: {
|
|
9470
|
+
readonly type: readonly ["object", "array"];
|
|
9471
|
+
readonly items: {
|
|
9472
|
+
readonly type: "string";
|
|
9473
|
+
};
|
|
9474
|
+
readonly additionalProperties: {
|
|
9475
|
+
readonly type: "string";
|
|
9476
|
+
};
|
|
9477
|
+
};
|
|
9478
|
+
readonly synthetics_data_key: {
|
|
9479
|
+
readonly type: "string";
|
|
9480
|
+
};
|
|
9481
|
+
readonly chart_title: {
|
|
9482
|
+
readonly type: "string";
|
|
9483
|
+
};
|
|
9484
|
+
readonly allow_csv_export: {
|
|
9485
|
+
readonly type: "boolean";
|
|
9486
|
+
};
|
|
9487
|
+
};
|
|
9488
|
+
readonly required: readonly ["type"];
|
|
9489
|
+
readonly additionalProperties: false;
|
|
8632
9490
|
}, {
|
|
8633
9491
|
readonly type: "object";
|
|
8634
9492
|
readonly properties: {
|