kb-cloud-client-typescript 2.3.21 → 2.3.23

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/src/adminapi.yaml CHANGED
@@ -22172,6 +22172,144 @@ paths:
22172
22172
  - session
22173
22173
  - rdbms
22174
22174
  - shared
22175
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/spaceAnalysis:
22176
+ get:
22177
+ tags:
22178
+ - diagnostics
22179
+ summary: Get MariaDB space analysis
22180
+ description: Get a read-only MariaDB compatible space snapshot and fixed backend-owned storage metrics.
22181
+ operationId: getDiagnosticsMariaDBSpaceAnalysis
22182
+ parameters:
22183
+ - name: orgName
22184
+ in: path
22185
+ required: true
22186
+ schema:
22187
+ type: string
22188
+ - name: clusterName
22189
+ in: path
22190
+ required: true
22191
+ schema:
22192
+ type: string
22193
+ - name: databaseName
22194
+ in: query
22195
+ description: Optional database name for table and index details. When omitted, the largest non-system database is selected.
22196
+ required: false
22197
+ schema:
22198
+ type: string
22199
+ responses:
22200
+ '200':
22201
+ description: OK
22202
+ content:
22203
+ application/json:
22204
+ schema:
22205
+ $ref: '#/components/schemas/mysqlSpaceAnalysis'
22206
+ '400':
22207
+ $ref: '#/components/responses/400'
22208
+ '401':
22209
+ $ref: '#/components/responses/401'
22210
+ '403':
22211
+ $ref: '#/components/responses/403'
22212
+ '404':
22213
+ $ref: '#/components/responses/404'
22214
+ '500':
22215
+ $ref: '#/components/responses/500'
22216
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/sqlAnalysis:
22217
+ get:
22218
+ tags:
22219
+ - diagnostics
22220
+ summary: Get MariaDB SQL analysis
22221
+ description: Get a read-only MariaDB SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
22222
+ operationId: getDiagnosticsMariaDBSQLAnalysis
22223
+ parameters:
22224
+ - name: orgName
22225
+ in: path
22226
+ description: Organization name
22227
+ required: true
22228
+ schema:
22229
+ type: string
22230
+ - name: clusterName
22231
+ in: path
22232
+ description: Cluster name
22233
+ required: true
22234
+ schema:
22235
+ type: string
22236
+ - name: limit
22237
+ in: query
22238
+ description: Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
22239
+ required: false
22240
+ schema:
22241
+ type: integer
22242
+ format: int64
22243
+ - name: orderBy
22244
+ in: query
22245
+ description: Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
22246
+ required: false
22247
+ schema:
22248
+ type: string
22249
+ responses:
22250
+ '200':
22251
+ description: OK
22252
+ content:
22253
+ application/json:
22254
+ schema:
22255
+ $ref: '#/components/schemas/mysqlSQLAnalysis'
22256
+ '400':
22257
+ $ref: '#/components/responses/400'
22258
+ '401':
22259
+ $ref: '#/components/responses/401'
22260
+ '403':
22261
+ $ref: '#/components/responses/403'
22262
+ '404':
22263
+ $ref: '#/components/responses/404'
22264
+ '500':
22265
+ $ref: '#/components/responses/500'
22266
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/performanceTrends:
22267
+ get:
22268
+ tags:
22269
+ - diagnostics
22270
+ summary: Get MariaDB performance trends
22271
+ description: Get read-only MariaDB performance trends from backend-owned metrics and database capability checks. The response does not expose SQL, PromQL, internal endpoints, or credentials.
22272
+ operationId: getDiagnosticsMariaDBPerformanceTrends
22273
+ parameters:
22274
+ - name: orgName
22275
+ in: path
22276
+ description: Organization name
22277
+ required: true
22278
+ schema:
22279
+ type: string
22280
+ - name: clusterName
22281
+ in: path
22282
+ description: Cluster name
22283
+ required: true
22284
+ schema:
22285
+ type: string
22286
+ - name: range
22287
+ in: query
22288
+ description: Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
22289
+ required: false
22290
+ schema:
22291
+ type: string
22292
+ - name: step
22293
+ in: query
22294
+ description: Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h.
22295
+ required: false
22296
+ schema:
22297
+ type: string
22298
+ responses:
22299
+ '200':
22300
+ description: OK
22301
+ content:
22302
+ application/json:
22303
+ schema:
22304
+ $ref: '#/components/schemas/performanceTrends'
22305
+ '400':
22306
+ $ref: '#/components/responses/400'
22307
+ '401':
22308
+ $ref: '#/components/responses/401'
22309
+ '403':
22310
+ $ref: '#/components/responses/403'
22311
+ '500':
22312
+ $ref: '#/components/responses/500'
22175
22313
  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/spaceAnalysis:
22176
22314
  get:
22177
22315
  tags:
@@ -43045,78 +43183,419 @@ components:
43045
43183
  collectedAt:
43046
43184
  type: string
43047
43185
  description: Backend collection timestamp in UTC.
43048
- mssqlRequest:
43186
+ mysqlSQLFingerprint:
43049
43187
  type: object
43050
43188
  required:
43051
- - requestId
43052
- - startedAt
43053
- - status
43054
- - command
43189
+ - queryID
43190
+ - fingerprint
43191
+ - querySummary
43192
+ - calls
43193
+ - totalTimeMs
43194
+ - meanTimeMs
43195
+ - maxTimeMs
43196
+ - rows
43197
+ - rowsSent
43198
+ - rowsAffected
43199
+ - rowsExamined
43200
+ - lockTimeMs
43201
+ - errors
43202
+ - warnings
43203
+ - tmpTables
43204
+ - tmpDiskTables
43205
+ - noIndexUsed
43206
+ - noGoodIndexUsed
43055
43207
  - database
43056
- - sql
43057
- - sqlTruncated
43058
- - elapsedMs
43059
- - cpuMs
43060
- - reads
43061
- - logicalReads
43062
- - writes
43063
- - waitType
43064
- - waitMs
43065
- - waitResource
43066
- - blockingSessionId
43067
43208
  properties:
43068
- requestId:
43069
- type: integer
43070
- format: int64
43071
- startedAt:
43072
- type: string
43073
- description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
43074
- status:
43075
- type: string
43076
- command:
43209
+ queryID:
43077
43210
  type: string
43078
- database:
43211
+ description: MySQL Performance Schema DIGEST value.
43212
+ fingerprint:
43079
43213
  type: string
43080
- sql:
43214
+ description: Stable SQL fingerprint identifier. M1 uses DIGEST.
43215
+ querySummary:
43081
43216
  type: string
43082
- description: Current statement extracted with byte offsets. Truncated to 8192 characters.
43083
- sqlTruncated:
43084
- type: boolean
43085
- elapsedMs:
43217
+ description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
43218
+ calls:
43086
43219
  type: integer
43087
43220
  format: int64
43088
- cpuMs:
43221
+ description: Number of executions accumulated in the current digest row.
43222
+ totalTimeMs:
43223
+ type: number
43224
+ format: double
43225
+ description: Total statement wait time in milliseconds.
43226
+ meanTimeMs:
43227
+ type: number
43228
+ format: double
43229
+ description: Mean statement wait time in milliseconds.
43230
+ maxTimeMs:
43231
+ type: number
43232
+ format: double
43233
+ description: Maximum statement wait time in milliseconds.
43234
+ rows:
43089
43235
  type: integer
43090
43236
  format: int64
43091
- reads:
43237
+ description: Sum of rows sent and rows affected.
43238
+ rowsSent:
43092
43239
  type: integer
43093
43240
  format: int64
43094
- logicalReads:
43241
+ description: Total rows sent to clients.
43242
+ rowsAffected:
43095
43243
  type: integer
43096
43244
  format: int64
43097
- writes:
43245
+ description: Total rows affected by statements.
43246
+ rowsExamined:
43098
43247
  type: integer
43099
43248
  format: int64
43100
- waitType:
43101
- type: string
43102
- waitMs:
43249
+ description: Total rows examined by statements.
43250
+ lockTimeMs:
43251
+ type: number
43252
+ format: double
43253
+ description: Total statement lock time in milliseconds.
43254
+ errors:
43103
43255
  type: integer
43104
43256
  format: int64
43105
- waitResource:
43106
- type: string
43107
- blockingSessionId:
43257
+ description: Total statement errors.
43258
+ warnings:
43108
43259
  type: integer
43109
43260
  format: int64
43110
- mssqlSession:
43261
+ description: Total statement warnings.
43262
+ tmpTables:
43263
+ type: integer
43264
+ format: int64
43265
+ description: Total internal temporary tables created.
43266
+ tmpDiskTables:
43267
+ type: integer
43268
+ format: int64
43269
+ description: Total internal on-disk temporary tables created.
43270
+ noIndexUsed:
43271
+ type: integer
43272
+ format: int64
43273
+ description: Executions that used no index.
43274
+ noGoodIndexUsed:
43275
+ type: integer
43276
+ format: int64
43277
+ description: Executions for which no good index was found.
43278
+ database:
43279
+ type: string
43280
+ description: Default schema name associated with the digest row.
43281
+ firstSeen:
43282
+ type: string
43283
+ description: UTC timestamp when the digest was first observed.
43284
+ lastSeen:
43285
+ type: string
43286
+ description: UTC timestamp when the digest was most recently observed.
43287
+ mysqlSQLAnalysis:
43111
43288
  type: object
43112
43289
  required:
43113
- - sessionId
43114
- - startedAt
43290
+ - source
43115
43291
  - status
43116
- - user
43117
- - host
43118
- - application
43119
- - client
43292
+ - collectedAt
43293
+ - limit
43294
+ - orderBy
43295
+ - items
43296
+ properties:
43297
+ source:
43298
+ type: string
43299
+ description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
43300
+ status:
43301
+ type: string
43302
+ description: Source status. Expected values are available or unavailable.
43303
+ unavailableReason:
43304
+ type: string
43305
+ description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
43306
+ message:
43307
+ type: string
43308
+ description: User-facing recovery guidance when SQL analysis is unavailable.
43309
+ collectedAt:
43310
+ type: string
43311
+ description: Backend collection timestamp in UTC. It is not a sampling-window end time.
43312
+ firstSeen:
43313
+ type: string
43314
+ description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
43315
+ lastSeen:
43316
+ type: string
43317
+ description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
43318
+ limit:
43319
+ type: integer
43320
+ format: int64
43321
+ description: Effective row limit after backend normalization.
43322
+ orderBy:
43323
+ type: string
43324
+ description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
43325
+ totalTimeMsAll:
43326
+ type: number
43327
+ format: double
43328
+ x-nullable: true
43329
+ description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
43330
+ callsAll:
43331
+ type: integer
43332
+ format: int64
43333
+ x-nullable: true
43334
+ description: Total execution count across all visible digest rows, not limited to the returned top-N items.
43335
+ digestLost:
43336
+ type: integer
43337
+ format: int64
43338
+ x-nullable: true
43339
+ description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
43340
+ items:
43341
+ type: array
43342
+ description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
43343
+ items:
43344
+ $ref: '#/components/schemas/mysqlSQLFingerprint'
43345
+ performanceTrendRange:
43346
+ type: object
43347
+ required:
43348
+ - label
43349
+ - start
43350
+ - end
43351
+ - durationSeconds
43352
+ properties:
43353
+ label:
43354
+ type: string
43355
+ description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
43356
+ start:
43357
+ type: string
43358
+ end:
43359
+ type: string
43360
+ durationSeconds:
43361
+ type: integer
43362
+ format: int64
43363
+ performanceTrendSummary:
43364
+ type: object
43365
+ required:
43366
+ - metric
43367
+ - displayName
43368
+ - category
43369
+ - unit
43370
+ - min
43371
+ - max
43372
+ - avg
43373
+ - latest
43374
+ properties:
43375
+ metric:
43376
+ type: string
43377
+ displayName:
43378
+ $ref: '#/components/schemas/localizedDescription'
43379
+ category:
43380
+ type: string
43381
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
43382
+ dimension:
43383
+ type: string
43384
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
43385
+ labels:
43386
+ type: object
43387
+ additionalProperties:
43388
+ type: string
43389
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
43390
+ unit:
43391
+ type: string
43392
+ warnThreshold:
43393
+ type: number
43394
+ format: double
43395
+ description: Optional warning threshold in the same unit as this metric.
43396
+ critThreshold:
43397
+ type: number
43398
+ format: double
43399
+ description: Optional critical threshold in the same unit as this metric.
43400
+ thresholdDirection:
43401
+ type: string
43402
+ description: Optional threshold direction. Values are above, below, or boolean.
43403
+ min:
43404
+ type: number
43405
+ format: double
43406
+ max:
43407
+ type: number
43408
+ format: double
43409
+ avg:
43410
+ type: number
43411
+ format: double
43412
+ latest:
43413
+ type: number
43414
+ format: double
43415
+ changeDirection:
43416
+ type: string
43417
+ description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
43418
+ performanceTrendPoint:
43419
+ type: object
43420
+ required:
43421
+ - timestamp
43422
+ - value
43423
+ properties:
43424
+ timestamp:
43425
+ type: string
43426
+ value:
43427
+ type: number
43428
+ format: double
43429
+ performanceTrendSeries:
43430
+ type: object
43431
+ required:
43432
+ - metric
43433
+ - displayName
43434
+ - category
43435
+ - unit
43436
+ - points
43437
+ properties:
43438
+ metric:
43439
+ type: string
43440
+ displayName:
43441
+ $ref: '#/components/schemas/localizedDescription'
43442
+ category:
43443
+ type: string
43444
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
43445
+ dimension:
43446
+ type: string
43447
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
43448
+ labels:
43449
+ type: object
43450
+ additionalProperties:
43451
+ type: string
43452
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
43453
+ unit:
43454
+ type: string
43455
+ warnThreshold:
43456
+ type: number
43457
+ format: double
43458
+ description: Optional warning threshold in the same unit as this metric.
43459
+ critThreshold:
43460
+ type: number
43461
+ format: double
43462
+ description: Optional critical threshold in the same unit as this metric.
43463
+ thresholdDirection:
43464
+ type: string
43465
+ description: Optional threshold direction. Values are above, below, or boolean.
43466
+ points:
43467
+ type: array
43468
+ items:
43469
+ $ref: '#/components/schemas/performanceTrendPoint'
43470
+ performanceTrendSource:
43471
+ type: object
43472
+ required:
43473
+ - name
43474
+ - kind
43475
+ - status
43476
+ - collectedAt
43477
+ properties:
43478
+ name:
43479
+ type: string
43480
+ kind:
43481
+ type: string
43482
+ status:
43483
+ type: string
43484
+ description: Coarse source status. Values are success, partial, failed, skipped, or noData.
43485
+ collectedAt:
43486
+ type: string
43487
+ message:
43488
+ type: string
43489
+ performanceTrends:
43490
+ type: object
43491
+ required:
43492
+ - range
43493
+ - granularity
43494
+ - summary
43495
+ - series
43496
+ - sources
43497
+ - warnings
43498
+ - collectedAt
43499
+ properties:
43500
+ range:
43501
+ $ref: '#/components/schemas/performanceTrendRange'
43502
+ granularity:
43503
+ type: string
43504
+ description: Controlled backend query step.
43505
+ summary:
43506
+ type: array
43507
+ description: Per-series numeric summary. changeDirection is present only when at least two points exist.
43508
+ items:
43509
+ $ref: '#/components/schemas/performanceTrendSummary'
43510
+ series:
43511
+ type: array
43512
+ description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
43513
+ items:
43514
+ $ref: '#/components/schemas/performanceTrendSeries'
43515
+ sources:
43516
+ type: array
43517
+ description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
43518
+ items:
43519
+ $ref: '#/components/schemas/performanceTrendSource'
43520
+ warnings:
43521
+ type: array
43522
+ items:
43523
+ type: string
43524
+ collectedAt:
43525
+ type: string
43526
+ description: Backend collection timestamp in UTC.
43527
+ mssqlRequest:
43528
+ type: object
43529
+ required:
43530
+ - requestId
43531
+ - startedAt
43532
+ - status
43533
+ - command
43534
+ - database
43535
+ - sql
43536
+ - sqlTruncated
43537
+ - elapsedMs
43538
+ - cpuMs
43539
+ - reads
43540
+ - logicalReads
43541
+ - writes
43542
+ - waitType
43543
+ - waitMs
43544
+ - waitResource
43545
+ - blockingSessionId
43546
+ properties:
43547
+ requestId:
43548
+ type: integer
43549
+ format: int64
43550
+ startedAt:
43551
+ type: string
43552
+ description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
43553
+ status:
43554
+ type: string
43555
+ command:
43556
+ type: string
43557
+ database:
43558
+ type: string
43559
+ sql:
43560
+ type: string
43561
+ description: Current statement extracted with byte offsets. Truncated to 8192 characters.
43562
+ sqlTruncated:
43563
+ type: boolean
43564
+ elapsedMs:
43565
+ type: integer
43566
+ format: int64
43567
+ cpuMs:
43568
+ type: integer
43569
+ format: int64
43570
+ reads:
43571
+ type: integer
43572
+ format: int64
43573
+ logicalReads:
43574
+ type: integer
43575
+ format: int64
43576
+ writes:
43577
+ type: integer
43578
+ format: int64
43579
+ waitType:
43580
+ type: string
43581
+ waitMs:
43582
+ type: integer
43583
+ format: int64
43584
+ waitResource:
43585
+ type: string
43586
+ blockingSessionId:
43587
+ type: integer
43588
+ format: int64
43589
+ mssqlSession:
43590
+ type: object
43591
+ required:
43592
+ - sessionId
43593
+ - startedAt
43594
+ - status
43595
+ - user
43596
+ - host
43597
+ - application
43598
+ - client
43120
43599
  - database
43121
43600
  - openTransactions
43122
43601
  - transactionSeconds
@@ -43640,214 +44119,17 @@ components:
43640
44119
  rows:
43641
44120
  type: integer
43642
44121
  format: int64
43643
- description: Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
43644
- database:
43645
- type: string
43646
- description: Database name resolved from pg_stat_statements.dbid when visible.
43647
- user:
43648
- type: string
43649
- description: Database user name resolved from pg_stat_statements.userid when visible.
43650
- topLevel:
43651
- type: boolean
43652
- description: Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
43653
- postgresqlSQLAnalysis:
43654
- type: object
43655
- required:
43656
- - source
43657
- - status
43658
- - collectedAt
43659
- - limit
43660
- - orderBy
43661
- - items
43662
- properties:
43663
- source:
43664
- type: string
43665
- description: Data source. M1 uses pg_stat_statements only.
43666
- status:
43667
- type: string
43668
- description: Source status. Expected values are available or unavailable.
43669
- unavailableReason:
43670
- type: string
43671
- description: Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
43672
- statsReset:
43673
- type: string
43674
- description: UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
43675
- collectedAt:
43676
- type: string
43677
- description: Backend collection timestamp in UTC. It is not a sampling-window end time.
43678
- limit:
43679
- type: integer
43680
- format: int64
43681
- description: Effective row limit after backend normalization.
43682
- orderBy:
43683
- type: string
43684
- description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
43685
- totalTimeMsAll:
43686
- type: number
43687
- format: double
43688
- x-nullable: true
43689
- description: Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
43690
- callsAll:
43691
- type: integer
43692
- format: int64
43693
- x-nullable: true
43694
- description: Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
43695
- items:
43696
- type: array
43697
- description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
43698
- items:
43699
- $ref: '#/components/schemas/postgresqlSQLFingerprint'
43700
- postgresqlSQLFingerprintExplainResponse:
43701
- type: object
43702
- required:
43703
- - queryID
43704
- - fingerprint
43705
- - database
43706
- - user
43707
- - topLevel
43708
- - planMode
43709
- - parameterized
43710
- - explainResult
43711
- properties:
43712
- queryID:
43713
- type: string
43714
- description: PostgreSQL pg_stat_statements queryid represented as a string.
43715
- fingerprint:
43716
- type: string
43717
- description: Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
43718
- database:
43719
- type: string
43720
- description: Database name from the requested SQL fingerprint identity.
43721
- user:
43722
- type: string
43723
- description: Database user from the requested SQL fingerprint identity.
43724
- topLevel:
43725
- type: boolean
43726
- description: Top-level flag from the requested SQL fingerprint identity.
43727
- statementSource:
43728
- type: string
43729
- description: Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
43730
- statementResolvedAt:
43731
- type: string
43732
- description: Timestamp when the parameterized SQL statement was resolved.
43733
- planMode:
43734
- $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
43735
- description: Whether DMS produced a standard estimated plan or a generic parameterized estimated plan.
43736
- parameterized:
43737
- type: boolean
43738
- description: Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
43739
- x-omitempty: false
43740
- parameterCount:
43741
- type: integer
43742
- format: int64
43743
- nullable: true
43744
- x-omitempty: true
43745
- description: Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
43746
- explainResult:
43747
- $ref: '#/components/schemas/DmsExecutionPlanResult'
43748
- description: Normalized DMS estimated visual plan. The resolved statement and generated EXPLAIN SQL are intentionally removed.
43749
- mysqlSQLFingerprint:
43750
- type: object
43751
- required:
43752
- - queryID
43753
- - fingerprint
43754
- - querySummary
43755
- - calls
43756
- - totalTimeMs
43757
- - meanTimeMs
43758
- - maxTimeMs
43759
- - rows
43760
- - rowsSent
43761
- - rowsAffected
43762
- - rowsExamined
43763
- - lockTimeMs
43764
- - errors
43765
- - warnings
43766
- - tmpTables
43767
- - tmpDiskTables
43768
- - noIndexUsed
43769
- - noGoodIndexUsed
43770
- - database
43771
- properties:
43772
- queryID:
43773
- type: string
43774
- description: MySQL Performance Schema DIGEST value.
43775
- fingerprint:
43776
- type: string
43777
- description: Stable SQL fingerprint identifier. M1 uses DIGEST.
43778
- querySummary:
43779
- type: string
43780
- description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
43781
- calls:
43782
- type: integer
43783
- format: int64
43784
- description: Number of executions accumulated in the current digest row.
43785
- totalTimeMs:
43786
- type: number
43787
- format: double
43788
- description: Total statement wait time in milliseconds.
43789
- meanTimeMs:
43790
- type: number
43791
- format: double
43792
- description: Mean statement wait time in milliseconds.
43793
- maxTimeMs:
43794
- type: number
43795
- format: double
43796
- description: Maximum statement wait time in milliseconds.
43797
- rows:
43798
- type: integer
43799
- format: int64
43800
- description: Sum of rows sent and rows affected.
43801
- rowsSent:
43802
- type: integer
43803
- format: int64
43804
- description: Total rows sent to clients.
43805
- rowsAffected:
43806
- type: integer
43807
- format: int64
43808
- description: Total rows affected by statements.
43809
- rowsExamined:
43810
- type: integer
43811
- format: int64
43812
- description: Total rows examined by statements.
43813
- lockTimeMs:
43814
- type: number
43815
- format: double
43816
- description: Total statement lock time in milliseconds.
43817
- errors:
43818
- type: integer
43819
- format: int64
43820
- description: Total statement errors.
43821
- warnings:
43822
- type: integer
43823
- format: int64
43824
- description: Total statement warnings.
43825
- tmpTables:
43826
- type: integer
43827
- format: int64
43828
- description: Total internal temporary tables created.
43829
- tmpDiskTables:
43830
- type: integer
43831
- format: int64
43832
- description: Total internal on-disk temporary tables created.
43833
- noIndexUsed:
43834
- type: integer
43835
- format: int64
43836
- description: Executions that used no index.
43837
- noGoodIndexUsed:
43838
- type: integer
43839
- format: int64
43840
- description: Executions for which no good index was found.
44122
+ description: Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
43841
44123
  database:
43842
44124
  type: string
43843
- description: Default schema name associated with the digest row.
43844
- firstSeen:
43845
- type: string
43846
- description: UTC timestamp when the digest was first observed.
43847
- lastSeen:
44125
+ description: Database name resolved from pg_stat_statements.dbid when visible.
44126
+ user:
43848
44127
  type: string
43849
- description: UTC timestamp when the digest was most recently observed.
43850
- mysqlSQLAnalysis:
44128
+ description: Database user name resolved from pg_stat_statements.userid when visible.
44129
+ topLevel:
44130
+ type: boolean
44131
+ description: Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
44132
+ postgresqlSQLAnalysis:
43851
44133
  type: object
43852
44134
  required:
43853
44135
  - source
@@ -43859,25 +44141,19 @@ components:
43859
44141
  properties:
43860
44142
  source:
43861
44143
  type: string
43862
- description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
44144
+ description: Data source. M1 uses pg_stat_statements only.
43863
44145
  status:
43864
44146
  type: string
43865
44147
  description: Source status. Expected values are available or unavailable.
43866
44148
  unavailableReason:
43867
44149
  type: string
43868
- description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
43869
- message:
44150
+ description: Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
44151
+ statsReset:
43870
44152
  type: string
43871
- description: User-facing recovery guidance when SQL analysis is unavailable.
44153
+ description: UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
43872
44154
  collectedAt:
43873
44155
  type: string
43874
44156
  description: Backend collection timestamp in UTC. It is not a sampling-window end time.
43875
- firstSeen:
43876
- type: string
43877
- description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
43878
- lastSeen:
43879
- type: string
43880
- description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
43881
44157
  limit:
43882
44158
  type: integer
43883
44159
  format: int64
@@ -43889,204 +44165,66 @@ components:
43889
44165
  type: number
43890
44166
  format: double
43891
44167
  x-nullable: true
43892
- description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
44168
+ description: Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
43893
44169
  callsAll:
43894
44170
  type: integer
43895
44171
  format: int64
43896
44172
  x-nullable: true
43897
- description: Total execution count across all visible digest rows, not limited to the returned top-N items.
43898
- digestLost:
43899
- type: integer
43900
- format: int64
43901
- x-nullable: true
43902
- description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
44173
+ description: Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
43903
44174
  items:
43904
44175
  type: array
43905
- description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
43906
- items:
43907
- $ref: '#/components/schemas/mysqlSQLFingerprint'
43908
- performanceTrendRange:
43909
- type: object
43910
- required:
43911
- - label
43912
- - start
43913
- - end
43914
- - durationSeconds
43915
- properties:
43916
- label:
43917
- type: string
43918
- description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
43919
- start:
43920
- type: string
43921
- end:
43922
- type: string
43923
- durationSeconds:
43924
- type: integer
43925
- format: int64
43926
- performanceTrendSummary:
43927
- type: object
43928
- required:
43929
- - metric
43930
- - displayName
43931
- - category
43932
- - unit
43933
- - min
43934
- - max
43935
- - avg
43936
- - latest
43937
- properties:
43938
- metric:
43939
- type: string
43940
- displayName:
43941
- $ref: '#/components/schemas/localizedDescription'
43942
- category:
43943
- type: string
43944
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
43945
- dimension:
43946
- type: string
43947
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
43948
- labels:
43949
- type: object
43950
- additionalProperties:
43951
- type: string
43952
- description: Optional dimension labels, for example instance, pvc, role, or datname.
43953
- unit:
43954
- type: string
43955
- warnThreshold:
43956
- type: number
43957
- format: double
43958
- description: Optional warning threshold in the same unit as this metric.
43959
- critThreshold:
43960
- type: number
43961
- format: double
43962
- description: Optional critical threshold in the same unit as this metric.
43963
- thresholdDirection:
43964
- type: string
43965
- description: Optional threshold direction. Values are above, below, or boolean.
43966
- min:
43967
- type: number
43968
- format: double
43969
- max:
43970
- type: number
43971
- format: double
43972
- avg:
43973
- type: number
43974
- format: double
43975
- latest:
43976
- type: number
43977
- format: double
43978
- changeDirection:
43979
- type: string
43980
- description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
43981
- performanceTrendPoint:
43982
- type: object
43983
- required:
43984
- - timestamp
43985
- - value
43986
- properties:
43987
- timestamp:
43988
- type: string
43989
- value:
43990
- type: number
43991
- format: double
43992
- performanceTrendSeries:
43993
- type: object
43994
- required:
43995
- - metric
43996
- - displayName
43997
- - category
43998
- - unit
43999
- - points
44000
- properties:
44001
- metric:
44002
- type: string
44003
- displayName:
44004
- $ref: '#/components/schemas/localizedDescription'
44005
- category:
44006
- type: string
44007
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
44008
- dimension:
44009
- type: string
44010
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
44011
- labels:
44012
- type: object
44013
- additionalProperties:
44014
- type: string
44015
- description: Optional dimension labels, for example instance, pvc, role, or datname.
44016
- unit:
44017
- type: string
44018
- warnThreshold:
44019
- type: number
44020
- format: double
44021
- description: Optional warning threshold in the same unit as this metric.
44022
- critThreshold:
44023
- type: number
44024
- format: double
44025
- description: Optional critical threshold in the same unit as this metric.
44026
- thresholdDirection:
44027
- type: string
44028
- description: Optional threshold direction. Values are above, below, or boolean.
44029
- points:
44030
- type: array
44176
+ description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
44031
44177
  items:
44032
- $ref: '#/components/schemas/performanceTrendPoint'
44033
- performanceTrendSource:
44178
+ $ref: '#/components/schemas/postgresqlSQLFingerprint'
44179
+ postgresqlSQLFingerprintExplainResponse:
44034
44180
  type: object
44035
44181
  required:
44036
- - name
44037
- - kind
44038
- - status
44039
- - collectedAt
44182
+ - queryID
44183
+ - fingerprint
44184
+ - database
44185
+ - user
44186
+ - topLevel
44187
+ - planMode
44188
+ - parameterized
44189
+ - explainResult
44040
44190
  properties:
44041
- name:
44042
- type: string
44043
- kind:
44191
+ queryID:
44044
44192
  type: string
44045
- status:
44193
+ description: PostgreSQL pg_stat_statements queryid represented as a string.
44194
+ fingerprint:
44046
44195
  type: string
44047
- description: Coarse source status. Values are success, partial, failed, skipped, or noData.
44048
- collectedAt:
44196
+ description: Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
44197
+ database:
44049
44198
  type: string
44050
- message:
44199
+ description: Database name from the requested SQL fingerprint identity.
44200
+ user:
44051
44201
  type: string
44052
- performanceTrends:
44053
- type: object
44054
- required:
44055
- - range
44056
- - granularity
44057
- - summary
44058
- - series
44059
- - sources
44060
- - warnings
44061
- - collectedAt
44062
- properties:
44063
- range:
44064
- $ref: '#/components/schemas/performanceTrendRange'
44065
- granularity:
44202
+ description: Database user from the requested SQL fingerprint identity.
44203
+ topLevel:
44204
+ type: boolean
44205
+ description: Top-level flag from the requested SQL fingerprint identity.
44206
+ statementSource:
44066
44207
  type: string
44067
- description: Controlled backend query step.
44068
- summary:
44069
- type: array
44070
- description: Per-series numeric summary. changeDirection is present only when at least two points exist.
44071
- items:
44072
- $ref: '#/components/schemas/performanceTrendSummary'
44073
- series:
44074
- type: array
44075
- description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
44076
- items:
44077
- $ref: '#/components/schemas/performanceTrendSeries'
44078
- sources:
44079
- type: array
44080
- description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
44081
- items:
44082
- $ref: '#/components/schemas/performanceTrendSource'
44083
- warnings:
44084
- type: array
44085
- items:
44086
- type: string
44087
- collectedAt:
44208
+ description: Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
44209
+ statementResolvedAt:
44088
44210
  type: string
44089
- description: Backend collection timestamp in UTC.
44211
+ description: Timestamp when the parameterized SQL statement was resolved.
44212
+ planMode:
44213
+ $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
44214
+ description: Whether DMS produced a standard estimated plan or a generic parameterized estimated plan.
44215
+ parameterized:
44216
+ type: boolean
44217
+ description: Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
44218
+ x-omitempty: false
44219
+ parameterCount:
44220
+ type: integer
44221
+ format: int64
44222
+ nullable: true
44223
+ x-omitempty: true
44224
+ description: Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
44225
+ explainResult:
44226
+ $ref: '#/components/schemas/DmsExecutionPlanResult'
44227
+ description: Normalized DMS estimated visual plan. The resolved statement and generated EXPLAIN SQL are intentionally removed.
44090
44228
  elasticsearchHotThreadsType:
44091
44229
  type: string
44092
44230
  enum: