@ancplua/qyl-api-schema 7.4.0 → 8.0.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/api/routes.tsp +109 -0
- package/generated/json-schema/qyl-api-schema.json +350 -0
- package/generated/openapi/qyl.openapi.json +918 -37
- package/generated/ts-runtime/api.d.ts +78 -0
- package/generated/ts-runtime/api.js +24 -1
- package/index.tsp +1 -0
- package/package.json +1 -1
|
@@ -41,6 +41,9 @@
|
|
|
41
41
|
{
|
|
42
42
|
"name": "Logs"
|
|
43
43
|
},
|
|
44
|
+
{
|
|
45
|
+
"name": "Metrics"
|
|
46
|
+
},
|
|
44
47
|
{
|
|
45
48
|
"name": "Sessions"
|
|
46
49
|
},
|
|
@@ -112,54 +115,656 @@
|
|
|
112
115
|
"schema": {
|
|
113
116
|
"type": "string"
|
|
114
117
|
},
|
|
115
|
-
"explode": false
|
|
116
|
-
},
|
|
118
|
+
"explode": false
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "severity_min",
|
|
122
|
+
"in": "query",
|
|
123
|
+
"required": false,
|
|
124
|
+
"schema": {
|
|
125
|
+
"$ref": "#/components/schemas/OTel.Enums.SeverityNumber"
|
|
126
|
+
},
|
|
127
|
+
"explode": false
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "trace_id",
|
|
131
|
+
"in": "query",
|
|
132
|
+
"required": false,
|
|
133
|
+
"schema": {
|
|
134
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
135
|
+
},
|
|
136
|
+
"explode": false
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "start_time",
|
|
140
|
+
"in": "query",
|
|
141
|
+
"required": false,
|
|
142
|
+
"schema": {
|
|
143
|
+
"type": "string",
|
|
144
|
+
"format": "date-time"
|
|
145
|
+
},
|
|
146
|
+
"explode": false
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "end_time",
|
|
150
|
+
"in": "query",
|
|
151
|
+
"required": false,
|
|
152
|
+
"schema": {
|
|
153
|
+
"type": "string",
|
|
154
|
+
"format": "date-time"
|
|
155
|
+
},
|
|
156
|
+
"explode": false
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "query",
|
|
160
|
+
"in": "query",
|
|
161
|
+
"required": false,
|
|
162
|
+
"schema": {
|
|
163
|
+
"type": "string"
|
|
164
|
+
},
|
|
165
|
+
"explode": false
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"name": "limit",
|
|
169
|
+
"in": "query",
|
|
170
|
+
"required": false,
|
|
171
|
+
"schema": {
|
|
172
|
+
"type": "integer",
|
|
173
|
+
"format": "int32",
|
|
174
|
+
"minimum": 1,
|
|
175
|
+
"maximum": 10000,
|
|
176
|
+
"default": 100
|
|
177
|
+
},
|
|
178
|
+
"explode": false
|
|
179
|
+
}
|
|
180
|
+
],
|
|
181
|
+
"responses": {
|
|
182
|
+
"200": {
|
|
183
|
+
"description": "The request has succeeded.",
|
|
184
|
+
"content": {
|
|
185
|
+
"application/json": {
|
|
186
|
+
"schema": {
|
|
187
|
+
"type": "object",
|
|
188
|
+
"required": [
|
|
189
|
+
"items",
|
|
190
|
+
"has_more"
|
|
191
|
+
],
|
|
192
|
+
"properties": {
|
|
193
|
+
"items": {
|
|
194
|
+
"type": "array",
|
|
195
|
+
"items": {
|
|
196
|
+
"$ref": "#/components/schemas/OTel.Logs.LogRecord"
|
|
197
|
+
},
|
|
198
|
+
"description": "List of items in this page"
|
|
199
|
+
},
|
|
200
|
+
"next_cursor": {
|
|
201
|
+
"type": "string",
|
|
202
|
+
"description": "Cursor for the next page (null if no more pages)"
|
|
203
|
+
},
|
|
204
|
+
"prev_cursor": {
|
|
205
|
+
"type": "string",
|
|
206
|
+
"description": "Cursor for the previous page (null if first page)"
|
|
207
|
+
},
|
|
208
|
+
"has_more": {
|
|
209
|
+
"type": "boolean",
|
|
210
|
+
"description": "Whether there are more items available"
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"unevaluatedProperties": {
|
|
214
|
+
"not": {}
|
|
215
|
+
},
|
|
216
|
+
"description": "Cursor-based paginated response wrapper"
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
},
|
|
221
|
+
"400": {
|
|
222
|
+
"description": "Bad request - validation failed (400)",
|
|
223
|
+
"headers": {
|
|
224
|
+
"X-Trace-Id": {
|
|
225
|
+
"required": false,
|
|
226
|
+
"description": "Trace ID for correlation",
|
|
227
|
+
"schema": {
|
|
228
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
229
|
+
}
|
|
230
|
+
},
|
|
231
|
+
"X-Request-Id": {
|
|
232
|
+
"required": false,
|
|
233
|
+
"description": "Request ID for support",
|
|
234
|
+
"schema": {
|
|
235
|
+
"type": "string"
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
"content": {
|
|
240
|
+
"application/problem+json": {
|
|
241
|
+
"schema": {
|
|
242
|
+
"$ref": "#/components/schemas/Common.Errors.ValidationError"
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"401": {
|
|
248
|
+
"description": "Unauthorized - authentication required (401)",
|
|
249
|
+
"headers": {
|
|
250
|
+
"WWW-Authenticate": {
|
|
251
|
+
"required": false,
|
|
252
|
+
"description": "Authentication scheme expected",
|
|
253
|
+
"schema": {
|
|
254
|
+
"type": "string"
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"X-Trace-Id": {
|
|
258
|
+
"required": false,
|
|
259
|
+
"description": "Trace ID for correlation",
|
|
260
|
+
"schema": {
|
|
261
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
"X-Request-Id": {
|
|
265
|
+
"required": false,
|
|
266
|
+
"description": "Request ID for support",
|
|
267
|
+
"schema": {
|
|
268
|
+
"type": "string"
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
"content": {
|
|
273
|
+
"application/problem+json": {
|
|
274
|
+
"schema": {
|
|
275
|
+
"$ref": "#/components/schemas/Common.Errors.UnauthorizedError"
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
},
|
|
280
|
+
"500": {
|
|
281
|
+
"description": "Internal server error (500)",
|
|
282
|
+
"headers": {
|
|
283
|
+
"X-Trace-Id": {
|
|
284
|
+
"required": false,
|
|
285
|
+
"description": "Trace ID for correlation",
|
|
286
|
+
"schema": {
|
|
287
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"X-Request-Id": {
|
|
291
|
+
"required": false,
|
|
292
|
+
"description": "Request ID for support",
|
|
293
|
+
"schema": {
|
|
294
|
+
"type": "string"
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
},
|
|
298
|
+
"content": {
|
|
299
|
+
"application/problem+json": {
|
|
300
|
+
"schema": {
|
|
301
|
+
"$ref": "#/components/schemas/Common.Errors.InternalServerError"
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
"tags": [
|
|
308
|
+
"Logs"
|
|
309
|
+
],
|
|
310
|
+
"security": [
|
|
311
|
+
{
|
|
312
|
+
"ApiKeyAuth": []
|
|
313
|
+
}
|
|
314
|
+
]
|
|
315
|
+
}
|
|
316
|
+
},
|
|
317
|
+
"/api/v1/metrics": {
|
|
318
|
+
"get": {
|
|
319
|
+
"operationId": "MetricsApi_list",
|
|
320
|
+
"description": "List the metric names recorded for a project.",
|
|
321
|
+
"parameters": [
|
|
322
|
+
{
|
|
323
|
+
"$ref": "#/components/parameters/ProjectScopeHeader"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "name_prefix",
|
|
327
|
+
"in": "query",
|
|
328
|
+
"required": false,
|
|
329
|
+
"description": "Return only names starting with this prefix.",
|
|
330
|
+
"schema": {
|
|
331
|
+
"type": "string"
|
|
332
|
+
},
|
|
333
|
+
"explode": false
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"name": "limit",
|
|
337
|
+
"in": "query",
|
|
338
|
+
"required": false,
|
|
339
|
+
"schema": {
|
|
340
|
+
"type": "integer",
|
|
341
|
+
"format": "int32",
|
|
342
|
+
"minimum": 1,
|
|
343
|
+
"maximum": 1000,
|
|
344
|
+
"default": 200
|
|
345
|
+
},
|
|
346
|
+
"explode": false
|
|
347
|
+
}
|
|
348
|
+
],
|
|
349
|
+
"responses": {
|
|
350
|
+
"200": {
|
|
351
|
+
"description": "The request has succeeded.",
|
|
352
|
+
"content": {
|
|
353
|
+
"application/json": {
|
|
354
|
+
"schema": {
|
|
355
|
+
"type": "object",
|
|
356
|
+
"required": [
|
|
357
|
+
"items",
|
|
358
|
+
"has_more"
|
|
359
|
+
],
|
|
360
|
+
"properties": {
|
|
361
|
+
"items": {
|
|
362
|
+
"type": "array",
|
|
363
|
+
"items": {
|
|
364
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricDescriptor"
|
|
365
|
+
},
|
|
366
|
+
"description": "List of items in this page"
|
|
367
|
+
},
|
|
368
|
+
"next_cursor": {
|
|
369
|
+
"type": "string",
|
|
370
|
+
"description": "Cursor for the next page (null if no more pages)"
|
|
371
|
+
},
|
|
372
|
+
"prev_cursor": {
|
|
373
|
+
"type": "string",
|
|
374
|
+
"description": "Cursor for the previous page (null if first page)"
|
|
375
|
+
},
|
|
376
|
+
"has_more": {
|
|
377
|
+
"type": "boolean",
|
|
378
|
+
"description": "Whether there are more items available"
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"unevaluatedProperties": {
|
|
382
|
+
"not": {}
|
|
383
|
+
},
|
|
384
|
+
"description": "Cursor-based paginated response wrapper"
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
"400": {
|
|
390
|
+
"description": "Bad request - validation failed (400)",
|
|
391
|
+
"headers": {
|
|
392
|
+
"X-Trace-Id": {
|
|
393
|
+
"required": false,
|
|
394
|
+
"description": "Trace ID for correlation",
|
|
395
|
+
"schema": {
|
|
396
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
"X-Request-Id": {
|
|
400
|
+
"required": false,
|
|
401
|
+
"description": "Request ID for support",
|
|
402
|
+
"schema": {
|
|
403
|
+
"type": "string"
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
},
|
|
407
|
+
"content": {
|
|
408
|
+
"application/problem+json": {
|
|
409
|
+
"schema": {
|
|
410
|
+
"$ref": "#/components/schemas/Common.Errors.ValidationError"
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
},
|
|
415
|
+
"401": {
|
|
416
|
+
"description": "Unauthorized - authentication required (401)",
|
|
417
|
+
"headers": {
|
|
418
|
+
"WWW-Authenticate": {
|
|
419
|
+
"required": false,
|
|
420
|
+
"description": "Authentication scheme expected",
|
|
421
|
+
"schema": {
|
|
422
|
+
"type": "string"
|
|
423
|
+
}
|
|
424
|
+
},
|
|
425
|
+
"X-Trace-Id": {
|
|
426
|
+
"required": false,
|
|
427
|
+
"description": "Trace ID for correlation",
|
|
428
|
+
"schema": {
|
|
429
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
430
|
+
}
|
|
431
|
+
},
|
|
432
|
+
"X-Request-Id": {
|
|
433
|
+
"required": false,
|
|
434
|
+
"description": "Request ID for support",
|
|
435
|
+
"schema": {
|
|
436
|
+
"type": "string"
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
"content": {
|
|
441
|
+
"application/problem+json": {
|
|
442
|
+
"schema": {
|
|
443
|
+
"$ref": "#/components/schemas/Common.Errors.UnauthorizedError"
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
},
|
|
448
|
+
"500": {
|
|
449
|
+
"description": "Internal server error (500)",
|
|
450
|
+
"headers": {
|
|
451
|
+
"X-Trace-Id": {
|
|
452
|
+
"required": false,
|
|
453
|
+
"description": "Trace ID for correlation",
|
|
454
|
+
"schema": {
|
|
455
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
"X-Request-Id": {
|
|
459
|
+
"required": false,
|
|
460
|
+
"description": "Request ID for support",
|
|
461
|
+
"schema": {
|
|
462
|
+
"type": "string"
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
"content": {
|
|
467
|
+
"application/problem+json": {
|
|
468
|
+
"schema": {
|
|
469
|
+
"$ref": "#/components/schemas/Common.Errors.InternalServerError"
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"tags": [
|
|
476
|
+
"Metrics"
|
|
477
|
+
],
|
|
478
|
+
"security": [
|
|
479
|
+
{
|
|
480
|
+
"ApiKeyAuth": []
|
|
481
|
+
}
|
|
482
|
+
]
|
|
483
|
+
}
|
|
484
|
+
},
|
|
485
|
+
"/api/v1/metrics/{metric_name}/query": {
|
|
486
|
+
"get": {
|
|
487
|
+
"operationId": "MetricsApi_query",
|
|
488
|
+
"description": "Aggregate one metric over a time range into buckets of `step_ms`.\nPercentile aggregations require a histogram kind.",
|
|
489
|
+
"parameters": [
|
|
490
|
+
{
|
|
491
|
+
"$ref": "#/components/parameters/ProjectScopeHeader"
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "metric_name",
|
|
495
|
+
"in": "path",
|
|
496
|
+
"required": true,
|
|
497
|
+
"schema": {
|
|
498
|
+
"type": "string"
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"name": "start_time",
|
|
503
|
+
"in": "query",
|
|
504
|
+
"required": true,
|
|
505
|
+
"schema": {
|
|
506
|
+
"type": "string",
|
|
507
|
+
"format": "date-time"
|
|
508
|
+
},
|
|
509
|
+
"explode": false
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"name": "end_time",
|
|
513
|
+
"in": "query",
|
|
514
|
+
"required": true,
|
|
515
|
+
"schema": {
|
|
516
|
+
"type": "string",
|
|
517
|
+
"format": "date-time"
|
|
518
|
+
},
|
|
519
|
+
"explode": false
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "step_ms",
|
|
523
|
+
"in": "query",
|
|
524
|
+
"required": false,
|
|
525
|
+
"description": "Bucket width in milliseconds. One bucket spanning the range collapses the query to a single value.",
|
|
526
|
+
"schema": {
|
|
527
|
+
"type": "integer",
|
|
528
|
+
"format": "int64",
|
|
529
|
+
"minimum": 1,
|
|
530
|
+
"maximum": 86400000,
|
|
531
|
+
"default": 60000
|
|
532
|
+
},
|
|
533
|
+
"explode": false
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"name": "aggregation",
|
|
537
|
+
"in": "query",
|
|
538
|
+
"required": false,
|
|
539
|
+
"schema": {
|
|
540
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricAggregation",
|
|
541
|
+
"default": "avg"
|
|
542
|
+
},
|
|
543
|
+
"explode": false
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
"name": "group_by",
|
|
547
|
+
"in": "query",
|
|
548
|
+
"required": false,
|
|
549
|
+
"description": "Attribute keys to split the result by, repeatable. Omitted, every matching series collapses into one stream.",
|
|
550
|
+
"schema": {
|
|
551
|
+
"type": "array",
|
|
552
|
+
"items": {
|
|
553
|
+
"type": "string"
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
"name": "attr",
|
|
559
|
+
"in": "query",
|
|
560
|
+
"required": false,
|
|
561
|
+
"description": "Exact attribute match, repeatable, as `key=value`.",
|
|
562
|
+
"schema": {
|
|
563
|
+
"type": "array",
|
|
564
|
+
"items": {
|
|
565
|
+
"type": "string"
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "attr_prefix",
|
|
571
|
+
"in": "query",
|
|
572
|
+
"required": false,
|
|
573
|
+
"description": "Attribute prefix match, repeatable, as `key=prefix`.",
|
|
574
|
+
"schema": {
|
|
575
|
+
"type": "array",
|
|
576
|
+
"items": {
|
|
577
|
+
"type": "string"
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"name": "series_limit",
|
|
583
|
+
"in": "query",
|
|
584
|
+
"required": false,
|
|
585
|
+
"description": "Maximum result streams. A grouping that exceeds this is truncated, not refused.",
|
|
586
|
+
"schema": {
|
|
587
|
+
"type": "integer",
|
|
588
|
+
"format": "int32",
|
|
589
|
+
"minimum": 1,
|
|
590
|
+
"maximum": 500,
|
|
591
|
+
"default": 50
|
|
592
|
+
},
|
|
593
|
+
"explode": false
|
|
594
|
+
}
|
|
595
|
+
],
|
|
596
|
+
"responses": {
|
|
597
|
+
"200": {
|
|
598
|
+
"description": "The request has succeeded.",
|
|
599
|
+
"content": {
|
|
600
|
+
"application/json": {
|
|
601
|
+
"schema": {
|
|
602
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricQueryResult"
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
"400": {
|
|
608
|
+
"description": "Bad request - validation failed (400)",
|
|
609
|
+
"headers": {
|
|
610
|
+
"X-Trace-Id": {
|
|
611
|
+
"required": false,
|
|
612
|
+
"description": "Trace ID for correlation",
|
|
613
|
+
"schema": {
|
|
614
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
"X-Request-Id": {
|
|
618
|
+
"required": false,
|
|
619
|
+
"description": "Request ID for support",
|
|
620
|
+
"schema": {
|
|
621
|
+
"type": "string"
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
"content": {
|
|
626
|
+
"application/problem+json": {
|
|
627
|
+
"schema": {
|
|
628
|
+
"$ref": "#/components/schemas/Common.Errors.ValidationError"
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
}
|
|
632
|
+
},
|
|
633
|
+
"401": {
|
|
634
|
+
"description": "Unauthorized - authentication required (401)",
|
|
635
|
+
"headers": {
|
|
636
|
+
"WWW-Authenticate": {
|
|
637
|
+
"required": false,
|
|
638
|
+
"description": "Authentication scheme expected",
|
|
639
|
+
"schema": {
|
|
640
|
+
"type": "string"
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"X-Trace-Id": {
|
|
644
|
+
"required": false,
|
|
645
|
+
"description": "Trace ID for correlation",
|
|
646
|
+
"schema": {
|
|
647
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
648
|
+
}
|
|
649
|
+
},
|
|
650
|
+
"X-Request-Id": {
|
|
651
|
+
"required": false,
|
|
652
|
+
"description": "Request ID for support",
|
|
653
|
+
"schema": {
|
|
654
|
+
"type": "string"
|
|
655
|
+
}
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
"content": {
|
|
659
|
+
"application/problem+json": {
|
|
660
|
+
"schema": {
|
|
661
|
+
"$ref": "#/components/schemas/Common.Errors.UnauthorizedError"
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
},
|
|
666
|
+
"404": {
|
|
667
|
+
"description": "Resource not found (404)",
|
|
668
|
+
"headers": {
|
|
669
|
+
"X-Trace-Id": {
|
|
670
|
+
"required": false,
|
|
671
|
+
"description": "Trace ID for correlation",
|
|
672
|
+
"schema": {
|
|
673
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
"X-Request-Id": {
|
|
677
|
+
"required": false,
|
|
678
|
+
"description": "Request ID for support",
|
|
679
|
+
"schema": {
|
|
680
|
+
"type": "string"
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
"content": {
|
|
685
|
+
"application/problem+json": {
|
|
686
|
+
"schema": {
|
|
687
|
+
"$ref": "#/components/schemas/Common.Errors.NotFoundError"
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
}
|
|
691
|
+
},
|
|
692
|
+
"500": {
|
|
693
|
+
"description": "Internal server error (500)",
|
|
694
|
+
"headers": {
|
|
695
|
+
"X-Trace-Id": {
|
|
696
|
+
"required": false,
|
|
697
|
+
"description": "Trace ID for correlation",
|
|
698
|
+
"schema": {
|
|
699
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
700
|
+
}
|
|
701
|
+
},
|
|
702
|
+
"X-Request-Id": {
|
|
703
|
+
"required": false,
|
|
704
|
+
"description": "Request ID for support",
|
|
705
|
+
"schema": {
|
|
706
|
+
"type": "string"
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
},
|
|
710
|
+
"content": {
|
|
711
|
+
"application/problem+json": {
|
|
712
|
+
"schema": {
|
|
713
|
+
"$ref": "#/components/schemas/Common.Errors.InternalServerError"
|
|
714
|
+
}
|
|
715
|
+
}
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
},
|
|
719
|
+
"tags": [
|
|
720
|
+
"Metrics"
|
|
721
|
+
],
|
|
722
|
+
"security": [
|
|
117
723
|
{
|
|
118
|
-
"
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
724
|
+
"ApiKeyAuth": []
|
|
725
|
+
}
|
|
726
|
+
]
|
|
727
|
+
}
|
|
728
|
+
},
|
|
729
|
+
"/api/v1/metrics/{metric_name}/series": {
|
|
730
|
+
"get": {
|
|
731
|
+
"operationId": "MetricsApi_listSeries",
|
|
732
|
+
"description": "List the distinct attribute streams recorded under one metric name.",
|
|
733
|
+
"parameters": [
|
|
126
734
|
{
|
|
127
|
-
"
|
|
128
|
-
"in": "query",
|
|
129
|
-
"required": false,
|
|
130
|
-
"schema": {
|
|
131
|
-
"$ref": "#/components/schemas/Common.TraceId"
|
|
132
|
-
},
|
|
133
|
-
"explode": false
|
|
735
|
+
"$ref": "#/components/parameters/ProjectScopeHeader"
|
|
134
736
|
},
|
|
135
737
|
{
|
|
136
|
-
"name": "
|
|
137
|
-
"in": "
|
|
138
|
-
"required":
|
|
738
|
+
"name": "metric_name",
|
|
739
|
+
"in": "path",
|
|
740
|
+
"required": true,
|
|
139
741
|
"schema": {
|
|
140
|
-
"type": "string"
|
|
141
|
-
|
|
142
|
-
},
|
|
143
|
-
"explode": false
|
|
742
|
+
"type": "string"
|
|
743
|
+
}
|
|
144
744
|
},
|
|
145
745
|
{
|
|
146
|
-
"name": "
|
|
746
|
+
"name": "attr",
|
|
147
747
|
"in": "query",
|
|
148
748
|
"required": false,
|
|
749
|
+
"description": "Exact attribute match, repeatable, as `key=value`. A series must match\nevery matcher given.",
|
|
149
750
|
"schema": {
|
|
150
|
-
"type": "
|
|
151
|
-
"
|
|
152
|
-
|
|
153
|
-
|
|
751
|
+
"type": "array",
|
|
752
|
+
"items": {
|
|
753
|
+
"type": "string"
|
|
754
|
+
}
|
|
755
|
+
}
|
|
154
756
|
},
|
|
155
757
|
{
|
|
156
|
-
"name": "
|
|
758
|
+
"name": "attr_prefix",
|
|
157
759
|
"in": "query",
|
|
158
760
|
"required": false,
|
|
761
|
+
"description": "Attribute prefix match, repeatable, as `key=prefix`.",
|
|
159
762
|
"schema": {
|
|
160
|
-
"type": "
|
|
161
|
-
|
|
162
|
-
|
|
763
|
+
"type": "array",
|
|
764
|
+
"items": {
|
|
765
|
+
"type": "string"
|
|
766
|
+
}
|
|
767
|
+
}
|
|
163
768
|
},
|
|
164
769
|
{
|
|
165
770
|
"name": "limit",
|
|
@@ -169,8 +774,8 @@
|
|
|
169
774
|
"type": "integer",
|
|
170
775
|
"format": "int32",
|
|
171
776
|
"minimum": 1,
|
|
172
|
-
"maximum":
|
|
173
|
-
"default":
|
|
777
|
+
"maximum": 1000,
|
|
778
|
+
"default": 200
|
|
174
779
|
},
|
|
175
780
|
"explode": false
|
|
176
781
|
}
|
|
@@ -190,7 +795,7 @@
|
|
|
190
795
|
"items": {
|
|
191
796
|
"type": "array",
|
|
192
797
|
"items": {
|
|
193
|
-
"$ref": "#/components/schemas/OTel.
|
|
798
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricSeries"
|
|
194
799
|
},
|
|
195
800
|
"description": "List of items in this page"
|
|
196
801
|
},
|
|
@@ -274,6 +879,32 @@
|
|
|
274
879
|
}
|
|
275
880
|
}
|
|
276
881
|
},
|
|
882
|
+
"404": {
|
|
883
|
+
"description": "Resource not found (404)",
|
|
884
|
+
"headers": {
|
|
885
|
+
"X-Trace-Id": {
|
|
886
|
+
"required": false,
|
|
887
|
+
"description": "Trace ID for correlation",
|
|
888
|
+
"schema": {
|
|
889
|
+
"$ref": "#/components/schemas/Common.TraceId"
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
"X-Request-Id": {
|
|
893
|
+
"required": false,
|
|
894
|
+
"description": "Request ID for support",
|
|
895
|
+
"schema": {
|
|
896
|
+
"type": "string"
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
},
|
|
900
|
+
"content": {
|
|
901
|
+
"application/problem+json": {
|
|
902
|
+
"schema": {
|
|
903
|
+
"$ref": "#/components/schemas/Common.Errors.NotFoundError"
|
|
904
|
+
}
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
},
|
|
277
908
|
"500": {
|
|
278
909
|
"description": "Internal server error (500)",
|
|
279
910
|
"headers": {
|
|
@@ -302,7 +933,7 @@
|
|
|
302
933
|
}
|
|
303
934
|
},
|
|
304
935
|
"tags": [
|
|
305
|
-
"
|
|
936
|
+
"Metrics"
|
|
306
937
|
],
|
|
307
938
|
"security": [
|
|
308
939
|
{
|
|
@@ -18181,6 +18812,256 @@
|
|
|
18181
18812
|
},
|
|
18182
18813
|
"description": "Log message template with placeholders"
|
|
18183
18814
|
},
|
|
18815
|
+
"OTel.Metrics.MetricAggregation": {
|
|
18816
|
+
"type": "string",
|
|
18817
|
+
"enum": [
|
|
18818
|
+
"avg",
|
|
18819
|
+
"min",
|
|
18820
|
+
"max",
|
|
18821
|
+
"sum",
|
|
18822
|
+
"count",
|
|
18823
|
+
"last",
|
|
18824
|
+
"p50",
|
|
18825
|
+
"p90",
|
|
18826
|
+
"p95",
|
|
18827
|
+
"p99"
|
|
18828
|
+
],
|
|
18829
|
+
"description": "Server-side reducer applied to the points falling in one time bucket."
|
|
18830
|
+
},
|
|
18831
|
+
"OTel.Metrics.MetricBucket": {
|
|
18832
|
+
"type": "object",
|
|
18833
|
+
"required": [
|
|
18834
|
+
"bucket_start",
|
|
18835
|
+
"value",
|
|
18836
|
+
"point_count"
|
|
18837
|
+
],
|
|
18838
|
+
"properties": {
|
|
18839
|
+
"bucket_start": {
|
|
18840
|
+
"type": "string",
|
|
18841
|
+
"format": "date-time",
|
|
18842
|
+
"description": "Inclusive start of the bucket, aligned to the query's step from the query's start."
|
|
18843
|
+
},
|
|
18844
|
+
"value": {
|
|
18845
|
+
"anyOf": [
|
|
18846
|
+
{
|
|
18847
|
+
"type": "number",
|
|
18848
|
+
"format": "double"
|
|
18849
|
+
},
|
|
18850
|
+
{
|
|
18851
|
+
"type": "null"
|
|
18852
|
+
}
|
|
18853
|
+
],
|
|
18854
|
+
"description": "The aggregation applied to the points in this bucket. Null when the bucket\nholds no value: either no point landed in it, or every point that did was\nan OTLP `NO_RECORDED_VALUE` marker."
|
|
18855
|
+
},
|
|
18856
|
+
"point_count": {
|
|
18857
|
+
"type": "integer",
|
|
18858
|
+
"format": "int64",
|
|
18859
|
+
"description": "Number of stored points folded into this bucket."
|
|
18860
|
+
}
|
|
18861
|
+
},
|
|
18862
|
+
"unevaluatedProperties": {
|
|
18863
|
+
"not": {}
|
|
18864
|
+
},
|
|
18865
|
+
"description": "One aggregated time bucket of a metric range query."
|
|
18866
|
+
},
|
|
18867
|
+
"OTel.Metrics.MetricDescriptor": {
|
|
18868
|
+
"type": "object",
|
|
18869
|
+
"required": [
|
|
18870
|
+
"name",
|
|
18871
|
+
"kind",
|
|
18872
|
+
"temporality",
|
|
18873
|
+
"monotonic",
|
|
18874
|
+
"series_count",
|
|
18875
|
+
"last_seen"
|
|
18876
|
+
],
|
|
18877
|
+
"properties": {
|
|
18878
|
+
"name": {
|
|
18879
|
+
"type": "string",
|
|
18880
|
+
"description": "Instrument name, e.g. `http.server.request.duration`."
|
|
18881
|
+
},
|
|
18882
|
+
"kind": {
|
|
18883
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricKind"
|
|
18884
|
+
},
|
|
18885
|
+
"temporality": {
|
|
18886
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricTemporality"
|
|
18887
|
+
},
|
|
18888
|
+
"monotonic": {
|
|
18889
|
+
"type": "boolean",
|
|
18890
|
+
"description": "Whether a sum only ever increases. Meaningless for other kinds."
|
|
18891
|
+
},
|
|
18892
|
+
"unit": {
|
|
18893
|
+
"type": "string",
|
|
18894
|
+
"description": "UCUM unit as reported by the producer, e.g. `s` or `{request}`."
|
|
18895
|
+
},
|
|
18896
|
+
"description": {
|
|
18897
|
+
"type": "string",
|
|
18898
|
+
"description": "Producer-supplied description of the instrument."
|
|
18899
|
+
},
|
|
18900
|
+
"series_count": {
|
|
18901
|
+
"type": "integer",
|
|
18902
|
+
"format": "int64",
|
|
18903
|
+
"description": "Number of distinct attribute streams recorded under this name."
|
|
18904
|
+
},
|
|
18905
|
+
"last_seen": {
|
|
18906
|
+
"type": "string",
|
|
18907
|
+
"format": "date-time",
|
|
18908
|
+
"description": "Timestamp of the most recent point recorded under this name."
|
|
18909
|
+
}
|
|
18910
|
+
},
|
|
18911
|
+
"unevaluatedProperties": {
|
|
18912
|
+
"not": {}
|
|
18913
|
+
},
|
|
18914
|
+
"description": "One metric name recorded for a project, collapsed across all of its series.\nThis is the catalog entry a client reads before it knows which series exist."
|
|
18915
|
+
},
|
|
18916
|
+
"OTel.Metrics.MetricKind": {
|
|
18917
|
+
"type": "string",
|
|
18918
|
+
"enum": [
|
|
18919
|
+
"gauge",
|
|
18920
|
+
"sum",
|
|
18921
|
+
"histogram",
|
|
18922
|
+
"exponential_histogram"
|
|
18923
|
+
],
|
|
18924
|
+
"description": "Shape of a stored metric stream."
|
|
18925
|
+
},
|
|
18926
|
+
"OTel.Metrics.MetricQueryResult": {
|
|
18927
|
+
"type": "object",
|
|
18928
|
+
"required": [
|
|
18929
|
+
"name",
|
|
18930
|
+
"kind",
|
|
18931
|
+
"aggregation",
|
|
18932
|
+
"step_ms",
|
|
18933
|
+
"start_time",
|
|
18934
|
+
"end_time",
|
|
18935
|
+
"series",
|
|
18936
|
+
"truncated"
|
|
18937
|
+
],
|
|
18938
|
+
"properties": {
|
|
18939
|
+
"name": {
|
|
18940
|
+
"type": "string",
|
|
18941
|
+
"description": "Instrument name the query ran against."
|
|
18942
|
+
},
|
|
18943
|
+
"kind": {
|
|
18944
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricKind"
|
|
18945
|
+
},
|
|
18946
|
+
"unit": {
|
|
18947
|
+
"type": "string"
|
|
18948
|
+
},
|
|
18949
|
+
"aggregation": {
|
|
18950
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricAggregation"
|
|
18951
|
+
},
|
|
18952
|
+
"step_ms": {
|
|
18953
|
+
"type": "integer",
|
|
18954
|
+
"format": "int64",
|
|
18955
|
+
"description": "Bucket width actually used, which may be widened from the requested step."
|
|
18956
|
+
},
|
|
18957
|
+
"start_time": {
|
|
18958
|
+
"type": "string",
|
|
18959
|
+
"format": "date-time"
|
|
18960
|
+
},
|
|
18961
|
+
"end_time": {
|
|
18962
|
+
"type": "string",
|
|
18963
|
+
"format": "date-time"
|
|
18964
|
+
},
|
|
18965
|
+
"series": {
|
|
18966
|
+
"type": "array",
|
|
18967
|
+
"items": {
|
|
18968
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricSeriesResult"
|
|
18969
|
+
}
|
|
18970
|
+
},
|
|
18971
|
+
"truncated": {
|
|
18972
|
+
"type": "boolean",
|
|
18973
|
+
"description": "Whether streams were dropped because the result exceeded the series limit."
|
|
18974
|
+
}
|
|
18975
|
+
},
|
|
18976
|
+
"unevaluatedProperties": {
|
|
18977
|
+
"not": {}
|
|
18978
|
+
},
|
|
18979
|
+
"description": "The answer to a metric range query: what was asked, and the streams it produced."
|
|
18980
|
+
},
|
|
18981
|
+
"OTel.Metrics.MetricSeries": {
|
|
18982
|
+
"type": "object",
|
|
18983
|
+
"required": [
|
|
18984
|
+
"series_id",
|
|
18985
|
+
"name",
|
|
18986
|
+
"kind",
|
|
18987
|
+
"attributes",
|
|
18988
|
+
"first_seen",
|
|
18989
|
+
"last_seen"
|
|
18990
|
+
],
|
|
18991
|
+
"properties": {
|
|
18992
|
+
"series_id": {
|
|
18993
|
+
"type": "string",
|
|
18994
|
+
"description": "Stable identifier for this stream, derived from its name, attributes and resource."
|
|
18995
|
+
},
|
|
18996
|
+
"name": {
|
|
18997
|
+
"type": "string",
|
|
18998
|
+
"description": "Instrument name this series belongs to."
|
|
18999
|
+
},
|
|
19000
|
+
"kind": {
|
|
19001
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricKind"
|
|
19002
|
+
},
|
|
19003
|
+
"attributes": {
|
|
19004
|
+
"type": "array",
|
|
19005
|
+
"items": {
|
|
19006
|
+
"$ref": "#/components/schemas/Common.Attribute"
|
|
19007
|
+
},
|
|
19008
|
+
"description": "The attributes that distinguish this series from others under the same name."
|
|
19009
|
+
},
|
|
19010
|
+
"service_name": {
|
|
19011
|
+
"type": "string"
|
|
19012
|
+
},
|
|
19013
|
+
"unit": {
|
|
19014
|
+
"type": "string"
|
|
19015
|
+
},
|
|
19016
|
+
"first_seen": {
|
|
19017
|
+
"type": "string",
|
|
19018
|
+
"format": "date-time"
|
|
19019
|
+
},
|
|
19020
|
+
"last_seen": {
|
|
19021
|
+
"type": "string",
|
|
19022
|
+
"format": "date-time"
|
|
19023
|
+
}
|
|
19024
|
+
},
|
|
19025
|
+
"unevaluatedProperties": {
|
|
19026
|
+
"not": {}
|
|
19027
|
+
},
|
|
19028
|
+
"description": "One distinct attribute stream recorded under a metric name."
|
|
19029
|
+
},
|
|
19030
|
+
"OTel.Metrics.MetricSeriesResult": {
|
|
19031
|
+
"type": "object",
|
|
19032
|
+
"required": [
|
|
19033
|
+
"attributes",
|
|
19034
|
+
"buckets"
|
|
19035
|
+
],
|
|
19036
|
+
"properties": {
|
|
19037
|
+
"attributes": {
|
|
19038
|
+
"type": "array",
|
|
19039
|
+
"items": {
|
|
19040
|
+
"$ref": "#/components/schemas/Common.Attribute"
|
|
19041
|
+
},
|
|
19042
|
+
"description": "The grouping key that produced this stream."
|
|
19043
|
+
},
|
|
19044
|
+
"buckets": {
|
|
19045
|
+
"type": "array",
|
|
19046
|
+
"items": {
|
|
19047
|
+
"$ref": "#/components/schemas/OTel.Metrics.MetricBucket"
|
|
19048
|
+
}
|
|
19049
|
+
}
|
|
19050
|
+
},
|
|
19051
|
+
"unevaluatedProperties": {
|
|
19052
|
+
"not": {}
|
|
19053
|
+
},
|
|
19054
|
+
"description": "One result stream of a metric range query. With no `group_by` the whole\nresult is a single stream whose `attributes` are empty; with `group_by` there\nis one stream per distinct combination of the requested attribute values."
|
|
19055
|
+
},
|
|
19056
|
+
"OTel.Metrics.MetricTemporality": {
|
|
19057
|
+
"type": "string",
|
|
19058
|
+
"enum": [
|
|
19059
|
+
"unspecified",
|
|
19060
|
+
"delta",
|
|
19061
|
+
"cumulative"
|
|
19062
|
+
],
|
|
19063
|
+
"description": "How successive points of a sum or histogram relate to each other."
|
|
19064
|
+
},
|
|
18184
19065
|
"OTel.Resource.CloudProvider": {
|
|
18185
19066
|
"type": "string",
|
|
18186
19067
|
"enum": [
|