kb-cloud-client-typescript 2.4.0-alpha.123 → 2.4.0-alpha.125

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.
Files changed (225) hide show
  1. package/dist/adminapi/apis/diagnostics-api.d.ts +423 -0
  2. package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/diagnostics-api.js +435 -0
  4. package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
  5. package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
  6. package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
  7. package/dist/adminapi/models/clickhouse-cluster-health-summary.js +16 -0
  8. package/dist/adminapi/models/clickhouse-cluster-health-summary.js.map +1 -0
  9. package/dist/adminapi/models/clickhouse-cluster-health.d.ts +71 -0
  10. package/dist/adminapi/models/clickhouse-cluster-health.d.ts.map +1 -0
  11. package/dist/adminapi/models/clickhouse-cluster-health.js +16 -0
  12. package/dist/adminapi/models/clickhouse-cluster-health.js.map +1 -0
  13. package/dist/adminapi/models/clickhouse-cluster-node.d.ts +109 -0
  14. package/dist/adminapi/models/clickhouse-cluster-node.d.ts.map +1 -0
  15. package/dist/adminapi/models/clickhouse-cluster-node.js +16 -0
  16. package/dist/adminapi/models/clickhouse-cluster-node.js.map +1 -0
  17. package/dist/adminapi/models/clickhouse-disk-usage.d.ts +61 -0
  18. package/dist/adminapi/models/clickhouse-disk-usage.d.ts.map +1 -0
  19. package/dist/adminapi/models/clickhouse-disk-usage.js +16 -0
  20. package/dist/adminapi/models/clickhouse-disk-usage.js.map +1 -0
  21. package/dist/adminapi/models/clickhouse-failed-query.d.ts +85 -0
  22. package/dist/adminapi/models/clickhouse-failed-query.d.ts.map +1 -0
  23. package/dist/adminapi/models/clickhouse-failed-query.js +16 -0
  24. package/dist/adminapi/models/clickhouse-failed-query.js.map +1 -0
  25. package/dist/adminapi/models/clickhouse-merge.d.ts +97 -0
  26. package/dist/adminapi/models/clickhouse-merge.d.ts.map +1 -0
  27. package/dist/adminapi/models/clickhouse-merge.js +16 -0
  28. package/dist/adminapi/models/clickhouse-merge.js.map +1 -0
  29. package/dist/adminapi/models/clickhouse-mutation.d.ts +79 -0
  30. package/dist/adminapi/models/clickhouse-mutation.d.ts.map +1 -0
  31. package/dist/adminapi/models/clickhouse-mutation.js +16 -0
  32. package/dist/adminapi/models/clickhouse-mutation.js.map +1 -0
  33. package/dist/adminapi/models/clickhouse-partition-space.d.ts +91 -0
  34. package/dist/adminapi/models/clickhouse-partition-space.d.ts.map +1 -0
  35. package/dist/adminapi/models/clickhouse-partition-space.js +16 -0
  36. package/dist/adminapi/models/clickhouse-partition-space.js.map +1 -0
  37. package/dist/adminapi/models/clickhouse-query-pattern.d.ts +91 -0
  38. package/dist/adminapi/models/clickhouse-query-pattern.d.ts.map +1 -0
  39. package/dist/adminapi/models/clickhouse-query-pattern.js +16 -0
  40. package/dist/adminapi/models/clickhouse-query-pattern.js.map +1 -0
  41. package/dist/adminapi/models/clickhouse-replica-health.d.ts +157 -0
  42. package/dist/adminapi/models/clickhouse-replica-health.d.ts.map +1 -0
  43. package/dist/adminapi/models/clickhouse-replica-health.js +16 -0
  44. package/dist/adminapi/models/clickhouse-replica-health.js.map +1 -0
  45. package/dist/adminapi/models/clickhouse-session-list.d.ts +45 -0
  46. package/dist/adminapi/models/clickhouse-session-list.d.ts.map +1 -0
  47. package/dist/adminapi/models/clickhouse-session-list.js +16 -0
  48. package/dist/adminapi/models/clickhouse-session-list.js.map +1 -0
  49. package/dist/adminapi/models/clickhouse-session.d.ts +139 -0
  50. package/dist/adminapi/models/clickhouse-session.d.ts.map +1 -0
  51. package/dist/adminapi/models/clickhouse-session.js +16 -0
  52. package/dist/adminapi/models/clickhouse-session.js.map +1 -0
  53. package/dist/adminapi/models/clickhouse-slow-query.d.ts +139 -0
  54. package/dist/adminapi/models/clickhouse-slow-query.d.ts.map +1 -0
  55. package/dist/adminapi/models/clickhouse-slow-query.js +16 -0
  56. package/dist/adminapi/models/clickhouse-slow-query.js.map +1 -0
  57. package/dist/adminapi/models/clickhouse-source.d.ts +43 -0
  58. package/dist/adminapi/models/clickhouse-source.d.ts.map +1 -0
  59. package/dist/adminapi/models/clickhouse-source.js +16 -0
  60. package/dist/adminapi/models/clickhouse-source.js.map +1 -0
  61. package/dist/adminapi/models/clickhouse-space-analysis.d.ts +79 -0
  62. package/dist/adminapi/models/clickhouse-space-analysis.d.ts.map +1 -0
  63. package/dist/adminapi/models/clickhouse-space-analysis.js +16 -0
  64. package/dist/adminapi/models/clickhouse-space-analysis.js.map +1 -0
  65. package/dist/adminapi/models/clickhouse-space-summary.d.ts +97 -0
  66. package/dist/adminapi/models/clickhouse-space-summary.d.ts.map +1 -0
  67. package/dist/adminapi/models/clickhouse-space-summary.js +16 -0
  68. package/dist/adminapi/models/clickhouse-space-summary.js.map +1 -0
  69. package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
  70. package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
  71. package/dist/adminapi/models/clickhouse-sqlanalysis-range.js +16 -0
  72. package/dist/adminapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
  73. package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts +85 -0
  74. package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
  75. package/dist/adminapi/models/clickhouse-sqlanalysis.js +16 -0
  76. package/dist/adminapi/models/clickhouse-sqlanalysis.js.map +1 -0
  77. package/dist/adminapi/models/clickhouse-sqlsummary.d.ts +43 -0
  78. package/dist/adminapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
  79. package/dist/adminapi/models/clickhouse-sqlsummary.js +16 -0
  80. package/dist/adminapi/models/clickhouse-sqlsummary.js.map +1 -0
  81. package/dist/adminapi/models/clickhouse-table-space.d.ts +104 -0
  82. package/dist/adminapi/models/clickhouse-table-space.d.ts.map +1 -0
  83. package/dist/adminapi/models/clickhouse-table-space.js +16 -0
  84. package/dist/adminapi/models/clickhouse-table-space.js.map +1 -0
  85. package/dist/adminapi/models/index.d.ts +20 -0
  86. package/dist/adminapi/models/index.d.ts.map +1 -1
  87. package/dist/adminapi/models/index.js +20 -0
  88. package/dist/adminapi/models/index.js.map +1 -1
  89. package/dist/openapi/apis/diagnostics-api.d.ts +423 -0
  90. package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
  91. package/dist/openapi/apis/diagnostics-api.js +435 -0
  92. package/dist/openapi/apis/diagnostics-api.js.map +1 -1
  93. package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
  94. package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
  95. package/dist/openapi/models/clickhouse-cluster-health-summary.js +16 -0
  96. package/dist/openapi/models/clickhouse-cluster-health-summary.js.map +1 -0
  97. package/dist/openapi/models/clickhouse-cluster-health.d.ts +71 -0
  98. package/dist/openapi/models/clickhouse-cluster-health.d.ts.map +1 -0
  99. package/dist/openapi/models/clickhouse-cluster-health.js +16 -0
  100. package/dist/openapi/models/clickhouse-cluster-health.js.map +1 -0
  101. package/dist/openapi/models/clickhouse-cluster-node.d.ts +109 -0
  102. package/dist/openapi/models/clickhouse-cluster-node.d.ts.map +1 -0
  103. package/dist/openapi/models/clickhouse-cluster-node.js +16 -0
  104. package/dist/openapi/models/clickhouse-cluster-node.js.map +1 -0
  105. package/dist/openapi/models/clickhouse-disk-usage.d.ts +61 -0
  106. package/dist/openapi/models/clickhouse-disk-usage.d.ts.map +1 -0
  107. package/dist/openapi/models/clickhouse-disk-usage.js +16 -0
  108. package/dist/openapi/models/clickhouse-disk-usage.js.map +1 -0
  109. package/dist/openapi/models/clickhouse-failed-query.d.ts +85 -0
  110. package/dist/openapi/models/clickhouse-failed-query.d.ts.map +1 -0
  111. package/dist/openapi/models/clickhouse-failed-query.js +16 -0
  112. package/dist/openapi/models/clickhouse-failed-query.js.map +1 -0
  113. package/dist/openapi/models/clickhouse-merge.d.ts +97 -0
  114. package/dist/openapi/models/clickhouse-merge.d.ts.map +1 -0
  115. package/dist/openapi/models/clickhouse-merge.js +16 -0
  116. package/dist/openapi/models/clickhouse-merge.js.map +1 -0
  117. package/dist/openapi/models/clickhouse-mutation.d.ts +79 -0
  118. package/dist/openapi/models/clickhouse-mutation.d.ts.map +1 -0
  119. package/dist/openapi/models/clickhouse-mutation.js +16 -0
  120. package/dist/openapi/models/clickhouse-mutation.js.map +1 -0
  121. package/dist/openapi/models/clickhouse-partition-space.d.ts +91 -0
  122. package/dist/openapi/models/clickhouse-partition-space.d.ts.map +1 -0
  123. package/dist/openapi/models/clickhouse-partition-space.js +16 -0
  124. package/dist/openapi/models/clickhouse-partition-space.js.map +1 -0
  125. package/dist/openapi/models/clickhouse-query-pattern.d.ts +91 -0
  126. package/dist/openapi/models/clickhouse-query-pattern.d.ts.map +1 -0
  127. package/dist/openapi/models/clickhouse-query-pattern.js +16 -0
  128. package/dist/openapi/models/clickhouse-query-pattern.js.map +1 -0
  129. package/dist/openapi/models/clickhouse-replica-health.d.ts +157 -0
  130. package/dist/openapi/models/clickhouse-replica-health.d.ts.map +1 -0
  131. package/dist/openapi/models/clickhouse-replica-health.js +16 -0
  132. package/dist/openapi/models/clickhouse-replica-health.js.map +1 -0
  133. package/dist/openapi/models/clickhouse-session-list.d.ts +45 -0
  134. package/dist/openapi/models/clickhouse-session-list.d.ts.map +1 -0
  135. package/dist/openapi/models/clickhouse-session-list.js +16 -0
  136. package/dist/openapi/models/clickhouse-session-list.js.map +1 -0
  137. package/dist/openapi/models/clickhouse-session.d.ts +139 -0
  138. package/dist/openapi/models/clickhouse-session.d.ts.map +1 -0
  139. package/dist/openapi/models/clickhouse-session.js +16 -0
  140. package/dist/openapi/models/clickhouse-session.js.map +1 -0
  141. package/dist/openapi/models/clickhouse-slow-query.d.ts +139 -0
  142. package/dist/openapi/models/clickhouse-slow-query.d.ts.map +1 -0
  143. package/dist/openapi/models/clickhouse-slow-query.js +16 -0
  144. package/dist/openapi/models/clickhouse-slow-query.js.map +1 -0
  145. package/dist/openapi/models/clickhouse-source.d.ts +43 -0
  146. package/dist/openapi/models/clickhouse-source.d.ts.map +1 -0
  147. package/dist/openapi/models/clickhouse-source.js +16 -0
  148. package/dist/openapi/models/clickhouse-source.js.map +1 -0
  149. package/dist/openapi/models/clickhouse-space-analysis.d.ts +79 -0
  150. package/dist/openapi/models/clickhouse-space-analysis.d.ts.map +1 -0
  151. package/dist/openapi/models/clickhouse-space-analysis.js +16 -0
  152. package/dist/openapi/models/clickhouse-space-analysis.js.map +1 -0
  153. package/dist/openapi/models/clickhouse-space-summary.d.ts +97 -0
  154. package/dist/openapi/models/clickhouse-space-summary.d.ts.map +1 -0
  155. package/dist/openapi/models/clickhouse-space-summary.js +16 -0
  156. package/dist/openapi/models/clickhouse-space-summary.js.map +1 -0
  157. package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
  158. package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
  159. package/dist/openapi/models/clickhouse-sqlanalysis-range.js +16 -0
  160. package/dist/openapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
  161. package/dist/openapi/models/clickhouse-sqlanalysis.d.ts +85 -0
  162. package/dist/openapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
  163. package/dist/openapi/models/clickhouse-sqlanalysis.js +16 -0
  164. package/dist/openapi/models/clickhouse-sqlanalysis.js.map +1 -0
  165. package/dist/openapi/models/clickhouse-sqlsummary.d.ts +43 -0
  166. package/dist/openapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
  167. package/dist/openapi/models/clickhouse-sqlsummary.js +16 -0
  168. package/dist/openapi/models/clickhouse-sqlsummary.js.map +1 -0
  169. package/dist/openapi/models/clickhouse-table-space.d.ts +104 -0
  170. package/dist/openapi/models/clickhouse-table-space.d.ts.map +1 -0
  171. package/dist/openapi/models/clickhouse-table-space.js +16 -0
  172. package/dist/openapi/models/clickhouse-table-space.js.map +1 -0
  173. package/dist/openapi/models/index.d.ts +20 -0
  174. package/dist/openapi/models/index.d.ts.map +1 -1
  175. package/dist/openapi/models/index.js +20 -0
  176. package/dist/openapi/models/index.js.map +1 -1
  177. package/package.json +1 -1
  178. package/src/adminapi/.openapi-generator/FILES +20 -0
  179. package/src/adminapi/apis/diagnostics-api.ts +746 -10
  180. package/src/adminapi/models/clickhouse-cluster-health-summary.ts +96 -0
  181. package/src/adminapi/models/clickhouse-cluster-health.ts +84 -0
  182. package/src/adminapi/models/clickhouse-cluster-node.ts +114 -0
  183. package/src/adminapi/models/clickhouse-disk-usage.ts +66 -0
  184. package/src/adminapi/models/clickhouse-failed-query.ts +90 -0
  185. package/src/adminapi/models/clickhouse-merge.ts +102 -0
  186. package/src/adminapi/models/clickhouse-mutation.ts +84 -0
  187. package/src/adminapi/models/clickhouse-partition-space.ts +96 -0
  188. package/src/adminapi/models/clickhouse-query-pattern.ts +96 -0
  189. package/src/adminapi/models/clickhouse-replica-health.ts +162 -0
  190. package/src/adminapi/models/clickhouse-session-list.ts +54 -0
  191. package/src/adminapi/models/clickhouse-session.ts +144 -0
  192. package/src/adminapi/models/clickhouse-slow-query.ts +144 -0
  193. package/src/adminapi/models/clickhouse-source.ts +48 -0
  194. package/src/adminapi/models/clickhouse-space-analysis.ts +96 -0
  195. package/src/adminapi/models/clickhouse-space-summary.ts +102 -0
  196. package/src/adminapi/models/clickhouse-sqlanalysis-range.ts +48 -0
  197. package/src/adminapi/models/clickhouse-sqlanalysis.ts +102 -0
  198. package/src/adminapi/models/clickhouse-sqlsummary.ts +48 -0
  199. package/src/adminapi/models/clickhouse-table-space.ts +111 -0
  200. package/src/adminapi/models/index.ts +20 -0
  201. package/src/adminapi.yaml +1158 -0
  202. package/src/openapi/.openapi-generator/FILES +20 -0
  203. package/src/openapi/apis/diagnostics-api.ts +746 -10
  204. package/src/openapi/models/clickhouse-cluster-health-summary.ts +96 -0
  205. package/src/openapi/models/clickhouse-cluster-health.ts +84 -0
  206. package/src/openapi/models/clickhouse-cluster-node.ts +114 -0
  207. package/src/openapi/models/clickhouse-disk-usage.ts +66 -0
  208. package/src/openapi/models/clickhouse-failed-query.ts +90 -0
  209. package/src/openapi/models/clickhouse-merge.ts +102 -0
  210. package/src/openapi/models/clickhouse-mutation.ts +84 -0
  211. package/src/openapi/models/clickhouse-partition-space.ts +96 -0
  212. package/src/openapi/models/clickhouse-query-pattern.ts +96 -0
  213. package/src/openapi/models/clickhouse-replica-health.ts +162 -0
  214. package/src/openapi/models/clickhouse-session-list.ts +54 -0
  215. package/src/openapi/models/clickhouse-session.ts +144 -0
  216. package/src/openapi/models/clickhouse-slow-query.ts +144 -0
  217. package/src/openapi/models/clickhouse-source.ts +48 -0
  218. package/src/openapi/models/clickhouse-space-analysis.ts +96 -0
  219. package/src/openapi/models/clickhouse-space-summary.ts +102 -0
  220. package/src/openapi/models/clickhouse-sqlanalysis-range.ts +48 -0
  221. package/src/openapi/models/clickhouse-sqlanalysis.ts +102 -0
  222. package/src/openapi/models/clickhouse-sqlsummary.ts +48 -0
  223. package/src/openapi/models/clickhouse-table-space.ts +111 -0
  224. package/src/openapi/models/index.ts +20 -0
  225. package/src/openapi.yaml +1158 -0
package/src/openapi.yaml CHANGED
@@ -8275,6 +8275,270 @@ paths:
8275
8275
  $ref: '#/components/responses/404'
8276
8276
  '500':
8277
8277
  $ref: '#/components/responses/500'
8278
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions:
8279
+ get:
8280
+ tags:
8281
+ - diagnostics
8282
+ summary: List active ClickHouse queries
8283
+ description: List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
8284
+ operationId: listDiagnosticsClickhouseSessions
8285
+ parameters:
8286
+ - name: orgName
8287
+ in: path
8288
+ description: Organization name
8289
+ required: true
8290
+ schema:
8291
+ type: string
8292
+ - name: clusterName
8293
+ in: path
8294
+ description: Cluster name
8295
+ required: true
8296
+ schema:
8297
+ type: string
8298
+ - name: limit
8299
+ in: query
8300
+ description: Maximum number of queries to return. Defaults to 100 and is capped at 1000.
8301
+ required: false
8302
+ schema:
8303
+ type: integer
8304
+ format: int64
8305
+ - name: orderBy
8306
+ in: query
8307
+ description: 'Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.'
8308
+ required: false
8309
+ schema:
8310
+ type: string
8311
+ - name: database
8312
+ in: query
8313
+ description: Filter by current database. Omit or empty = all databases.
8314
+ required: false
8315
+ schema:
8316
+ type: string
8317
+ responses:
8318
+ '200':
8319
+ description: OK
8320
+ content:
8321
+ application/json:
8322
+ schema:
8323
+ $ref: '#/components/schemas/clickhouseSessionList'
8324
+ '400':
8325
+ $ref: '#/components/responses/400'
8326
+ '401':
8327
+ $ref: '#/components/responses/401'
8328
+ '403':
8329
+ $ref: '#/components/responses/403'
8330
+ '404':
8331
+ $ref: '#/components/responses/404'
8332
+ '500':
8333
+ $ref: '#/components/responses/500'
8334
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions/{queryId}:
8335
+ delete:
8336
+ tags:
8337
+ - diagnostics
8338
+ summary: Kill a ClickHouse query
8339
+ description: Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
8340
+ operationId: killDiagnosticsClickhouseQuery
8341
+ parameters:
8342
+ - name: orgName
8343
+ in: path
8344
+ description: Organization name
8345
+ required: true
8346
+ schema:
8347
+ type: string
8348
+ - name: clusterName
8349
+ in: path
8350
+ description: Cluster name
8351
+ required: true
8352
+ schema:
8353
+ type: string
8354
+ - name: queryId
8355
+ in: path
8356
+ description: ClickHouse query_id to terminate.
8357
+ required: true
8358
+ schema:
8359
+ type: string
8360
+ responses:
8361
+ '204':
8362
+ description: Query killed successfully.
8363
+ '400':
8364
+ $ref: '#/components/responses/400'
8365
+ '401':
8366
+ $ref: '#/components/responses/401'
8367
+ '403':
8368
+ $ref: '#/components/responses/403'
8369
+ '404':
8370
+ $ref: '#/components/responses/404'
8371
+ '500':
8372
+ $ref: '#/components/responses/500'
8373
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sqlAnalysis:
8374
+ get:
8375
+ tags:
8376
+ - diagnostics
8377
+ summary: Get ClickHouse SQL analysis
8378
+ description: Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
8379
+ operationId: getDiagnosticsClickhouseSQLAnalysis
8380
+ parameters:
8381
+ - name: orgName
8382
+ in: path
8383
+ description: Organization name
8384
+ required: true
8385
+ schema:
8386
+ type: string
8387
+ - name: clusterName
8388
+ in: path
8389
+ description: Cluster name
8390
+ required: true
8391
+ schema:
8392
+ type: string
8393
+ - name: range
8394
+ in: query
8395
+ description: 'Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.'
8396
+ required: false
8397
+ schema:
8398
+ type: string
8399
+ - name: limit
8400
+ in: query
8401
+ description: Maximum number of entries per list. Defaults to 20 and is capped at 200.
8402
+ required: false
8403
+ schema:
8404
+ type: integer
8405
+ format: int64
8406
+ - name: orderBy
8407
+ in: query
8408
+ description: 'Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.'
8409
+ required: false
8410
+ schema:
8411
+ type: string
8412
+ - name: database
8413
+ in: query
8414
+ description: Filter by current_database. Omit or empty = all databases.
8415
+ required: false
8416
+ schema:
8417
+ type: string
8418
+ - name: user
8419
+ in: query
8420
+ description: Filter by ClickHouse user. Omit or empty = all users.
8421
+ required: false
8422
+ schema:
8423
+ type: string
8424
+ responses:
8425
+ '200':
8426
+ description: OK
8427
+ content:
8428
+ application/json:
8429
+ schema:
8430
+ $ref: '#/components/schemas/clickhouseSQLAnalysis'
8431
+ '400':
8432
+ $ref: '#/components/responses/400'
8433
+ '401':
8434
+ $ref: '#/components/responses/401'
8435
+ '403':
8436
+ $ref: '#/components/responses/403'
8437
+ '404':
8438
+ $ref: '#/components/responses/404'
8439
+ '500':
8440
+ $ref: '#/components/responses/500'
8441
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/spaceAnalysis:
8442
+ get:
8443
+ tags:
8444
+ - diagnostics
8445
+ summary: Get ClickHouse space analysis
8446
+ description: Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
8447
+ operationId: getDiagnosticsClickhouseSpaceAnalysis
8448
+ parameters:
8449
+ - name: orgName
8450
+ in: path
8451
+ description: Organization name
8452
+ required: true
8453
+ schema:
8454
+ type: string
8455
+ - name: clusterName
8456
+ in: path
8457
+ description: Cluster name
8458
+ required: true
8459
+ schema:
8460
+ type: string
8461
+ - name: database
8462
+ in: query
8463
+ description: Filter by database. Omit or empty = all databases.
8464
+ required: false
8465
+ schema:
8466
+ type: string
8467
+ - name: tableLimit
8468
+ in: query
8469
+ description: Maximum number of top tables. Defaults to 20 and is capped at 200.
8470
+ required: false
8471
+ schema:
8472
+ type: integer
8473
+ format: int64
8474
+ - name: partitionLimit
8475
+ in: query
8476
+ description: Maximum number of top partitions. Defaults to 20 and is capped at 200.
8477
+ required: false
8478
+ schema:
8479
+ type: integer
8480
+ format: int64
8481
+ - name: mergeLimit
8482
+ in: query
8483
+ description: Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
8484
+ required: false
8485
+ schema:
8486
+ type: integer
8487
+ format: int64
8488
+ responses:
8489
+ '200':
8490
+ description: OK
8491
+ content:
8492
+ application/json:
8493
+ schema:
8494
+ $ref: '#/components/schemas/clickhouseSpaceAnalysis'
8495
+ '400':
8496
+ $ref: '#/components/responses/400'
8497
+ '401':
8498
+ $ref: '#/components/responses/401'
8499
+ '403':
8500
+ $ref: '#/components/responses/403'
8501
+ '404':
8502
+ $ref: '#/components/responses/404'
8503
+ '500':
8504
+ $ref: '#/components/responses/500'
8505
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/clusterHealth:
8506
+ get:
8507
+ tags:
8508
+ - diagnostics
8509
+ summary: Get ClickHouse replica and cluster health
8510
+ description: Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node's system.clusters view.
8511
+ operationId: getDiagnosticsClickhouseClusterHealth
8512
+ parameters:
8513
+ - name: orgName
8514
+ in: path
8515
+ description: Organization name
8516
+ required: true
8517
+ schema:
8518
+ type: string
8519
+ - name: clusterName
8520
+ in: path
8521
+ description: Cluster name
8522
+ required: true
8523
+ schema:
8524
+ type: string
8525
+ responses:
8526
+ '200':
8527
+ description: OK
8528
+ content:
8529
+ application/json:
8530
+ schema:
8531
+ $ref: '#/components/schemas/clickhouseClusterHealth'
8532
+ '400':
8533
+ $ref: '#/components/responses/400'
8534
+ '401':
8535
+ $ref: '#/components/responses/401'
8536
+ '403':
8537
+ $ref: '#/components/responses/403'
8538
+ '404':
8539
+ $ref: '#/components/responses/404'
8540
+ '500':
8541
+ $ref: '#/components/responses/500'
8278
8542
  /api/v1/organizations/{orgName}/clusters/{clusterName}/metrics:
8279
8543
  get:
8280
8544
  description: Query cluster metrics by specified metric name and instance name, support instant and range query
@@ -33905,6 +34169,900 @@ components:
33905
34169
  type: string
33906
34170
  collectedAt:
33907
34171
  type: string
34172
+ clickhouseSession:
34173
+ type: object
34174
+ required:
34175
+ - queryId
34176
+ properties:
34177
+ queryId:
34178
+ type: string
34179
+ description: ClickHouse query_id. Use it with the KILL QUERY endpoint.
34180
+ initialQueryId:
34181
+ type: string
34182
+ description: query_id of the initial (distributed) query when this row is a remote sub-query.
34183
+ user:
34184
+ type: string
34185
+ description: User that started the query.
34186
+ address:
34187
+ type: string
34188
+ description: Client address.
34189
+ port:
34190
+ type: integer
34191
+ format: int64
34192
+ description: Client port.
34193
+ database:
34194
+ type: string
34195
+ description: Current database of the query.
34196
+ hostName:
34197
+ type: string
34198
+ description: ClickHouse server host that reported the query.
34199
+ elapsedSeconds:
34200
+ type: number
34201
+ format: double
34202
+ description: Seconds elapsed since the query started.
34203
+ readRows:
34204
+ type: integer
34205
+ format: int64
34206
+ description: Rows read so far.
34207
+ readBytes:
34208
+ type: integer
34209
+ format: int64
34210
+ description: Bytes read so far.
34211
+ writtenRows:
34212
+ type: integer
34213
+ format: int64
34214
+ description: Rows written so far.
34215
+ writtenBytes:
34216
+ type: integer
34217
+ format: int64
34218
+ description: Bytes written so far.
34219
+ memoryUsageBytes:
34220
+ type: integer
34221
+ format: int64
34222
+ description: Current memory usage in bytes.
34223
+ memoryLimitBytes:
34224
+ type: integer
34225
+ format: int64
34226
+ description: max_memory_usage from the query Settings map (only explicitly modified settings). Zero means the query did not set a limit, so the server default applies.
34227
+ memoryUsageRatio:
34228
+ type: number
34229
+ format: double
34230
+ description: memory_usage / memoryLimitBytes (0-1). Zero when the query did not explicitly set max_memory_usage. Values close to 1 indicate the query is about to hit its memory limit.
34231
+ peakMemoryUsageBytes:
34232
+ type: integer
34233
+ format: int64
34234
+ description: Peak memory usage in bytes. Zero when the server version does not expose peak_memory_usage.
34235
+ isInitialQuery:
34236
+ type: boolean
34237
+ description: Whether this row is the initial query rather than a remote sub-query.
34238
+ queryStartTime:
34239
+ type: string
34240
+ description: Estimated query start time in RFC3339 UTC, computed from elapsed because system.processes has no start timestamp.
34241
+ query:
34242
+ type: string
34243
+ description: Query text with string and numeric literals and comments masked as ? before returning.
34244
+ querySummary:
34245
+ type: string
34246
+ description: Single-line masked query summary suitable for list rendering.
34247
+ clickhouseSource:
34248
+ type: object
34249
+ properties:
34250
+ name:
34251
+ type: string
34252
+ description: Source expression, for example clusterAllReplicas('ck', system.processes).
34253
+ kind:
34254
+ type: string
34255
+ description: Logical source kind (system table or collection step).
34256
+ status:
34257
+ type: string
34258
+ description: Collection status (success, partial, failed).
34259
+ message:
34260
+ type: string
34261
+ description: Short human-readable status detail.
34262
+ clickhouseSessionList:
34263
+ type: object
34264
+ required:
34265
+ - collectedAt
34266
+ - items
34267
+ - sources
34268
+ properties:
34269
+ collectedAt:
34270
+ type: string
34271
+ description: Collection time in RFC3339 UTC.
34272
+ clusterMode:
34273
+ type: string
34274
+ description: Detected deployment mode (standalone or cluster). When clusterAllReplicas fails and the local node is used instead, this is reported as standalone.
34275
+ items:
34276
+ type: array
34277
+ description: Active queries collected from system.processes, ordered by the requested metric.
34278
+ items:
34279
+ $ref: '#/components/schemas/clickhouseSession'
34280
+ sources:
34281
+ type: array
34282
+ description: Per-source collection status. In cluster mode one entry is returned per clusterAllReplicas expression.
34283
+ items:
34284
+ $ref: '#/components/schemas/clickhouseSource'
34285
+ clickhouseSQLAnalysisRange:
34286
+ type: object
34287
+ properties:
34288
+ label:
34289
+ type: string
34290
+ description: Requested range label (1h, 6h, 24h, 7d).
34291
+ start:
34292
+ type: string
34293
+ description: Range start in RFC3339 UTC.
34294
+ end:
34295
+ type: string
34296
+ description: Range end in RFC3339 UTC.
34297
+ durationSeconds:
34298
+ type: integer
34299
+ format: int64
34300
+ description: Range duration in seconds.
34301
+ clickhouseSQLSummary:
34302
+ type: object
34303
+ properties:
34304
+ queryCount:
34305
+ type: integer
34306
+ format: int64
34307
+ description: Finished and failed queries in the selected range.
34308
+ failedCount:
34309
+ type: integer
34310
+ format: int64
34311
+ description: Queries that ended with ExceptionWhileProcessing.
34312
+ slowQueryCount:
34313
+ type: integer
34314
+ format: int64
34315
+ description: Queries whose duration is at least 1000 ms.
34316
+ totalDurationMs:
34317
+ type: number
34318
+ format: double
34319
+ description: Sum of query_duration_ms for all finished and failed queries.
34320
+ clickhouseSlowQuery:
34321
+ type: object
34322
+ properties:
34323
+ queryId:
34324
+ type: string
34325
+ description: ClickHouse query_id.
34326
+ initialQueryId:
34327
+ type: string
34328
+ description: Initial query_id for a distributed query.
34329
+ type:
34330
+ type: string
34331
+ description: query_log type (QueryFinish or ExceptionWhileProcessing).
34332
+ user:
34333
+ type: string
34334
+ description: User that ran the query.
34335
+ database:
34336
+ type: string
34337
+ description: Current database at execution time.
34338
+ queryKind:
34339
+ type: string
34340
+ description: Query kind reported by ClickHouse.
34341
+ query:
34342
+ type: string
34343
+ description: Query text with string and numeric literals and comments masked as ?.
34344
+ normalizedQueryHash:
34345
+ type: string
34346
+ description: normalized_query_hash as a string to avoid precision loss in clients.
34347
+ durationMs:
34348
+ type: number
34349
+ format: double
34350
+ description: query_duration_ms.
34351
+ readRows:
34352
+ type: integer
34353
+ format: int64
34354
+ description: Rows read by the query.
34355
+ readBytes:
34356
+ type: integer
34357
+ format: int64
34358
+ description: Bytes read by the query.
34359
+ memoryUsageBytes:
34360
+ type: integer
34361
+ format: int64
34362
+ description: Memory usage in bytes.
34363
+ resultRows:
34364
+ type: integer
34365
+ format: int64
34366
+ description: Rows returned by the query.
34367
+ resultBytes:
34368
+ type: integer
34369
+ format: int64
34370
+ description: Bytes returned by the query.
34371
+ exceptionCode:
34372
+ type: integer
34373
+ format: int64
34374
+ description: ClickHouse exception code, zero for successful queries.
34375
+ exception:
34376
+ type: string
34377
+ description: Exception text for failed queries.
34378
+ eventTime:
34379
+ type: string
34380
+ description: query_log event time in RFC3339 UTC.
34381
+ hostName:
34382
+ type: string
34383
+ description: ClickHouse server host that ran the query.
34384
+ clientName:
34385
+ type: string
34386
+ description: Client name reported by ClickHouse.
34387
+ isInitialQuery:
34388
+ type: boolean
34389
+ description: Whether this is the initial query rather than a remote sub-query.
34390
+ clickhouseQueryPattern:
34391
+ type: object
34392
+ properties:
34393
+ normalizedQueryHash:
34394
+ type: string
34395
+ description: normalized_query_hash as a string.
34396
+ sampleQuery:
34397
+ type: string
34398
+ description: One representative query text for the pattern, with string and numeric literals and comments masked as ?.
34399
+ calls:
34400
+ type: integer
34401
+ format: int64
34402
+ description: Number of executions of the pattern.
34403
+ totalDurationMs:
34404
+ type: number
34405
+ format: double
34406
+ description: Sum of query_duration_ms across all executions.
34407
+ meanDurationMs:
34408
+ type: number
34409
+ format: double
34410
+ description: Average query_duration_ms.
34411
+ maxDurationMs:
34412
+ type: number
34413
+ format: double
34414
+ description: Maximum query_duration_ms.
34415
+ readRows:
34416
+ type: integer
34417
+ format: int64
34418
+ description: Sum of read_rows.
34419
+ memoryUsageBytes:
34420
+ type: integer
34421
+ format: int64
34422
+ description: Sum of memory_usage in bytes.
34423
+ failureCount:
34424
+ type: integer
34425
+ format: int64
34426
+ description: Executions that ended with ExceptionWhileProcessing.
34427
+ slowCallCount:
34428
+ type: integer
34429
+ format: int64
34430
+ description: Executions whose duration is at least 1000 ms.
34431
+ firstSeen:
34432
+ type: string
34433
+ description: First event_time in RFC3339 UTC.
34434
+ lastSeen:
34435
+ type: string
34436
+ description: Last event_time in RFC3339 UTC.
34437
+ clickhouseFailedQuery:
34438
+ type: object
34439
+ properties:
34440
+ eventTime:
34441
+ type: string
34442
+ description: query_log event time in RFC3339 UTC.
34443
+ queryId:
34444
+ type: string
34445
+ description: ClickHouse query_id.
34446
+ user:
34447
+ type: string
34448
+ description: User that ran the query.
34449
+ database:
34450
+ type: string
34451
+ description: Current database at execution time.
34452
+ query:
34453
+ type: string
34454
+ description: Query text with string and numeric literals and comments masked as ?.
34455
+ exceptionCode:
34456
+ type: integer
34457
+ format: int64
34458
+ description: ClickHouse exception code.
34459
+ exceptionCategory:
34460
+ type: string
34461
+ description: Best-effort category such as memory_limit_exceeded, timeout, too_many_parts, readonly, unknown_table or syntax_error.
34462
+ exception:
34463
+ type: string
34464
+ description: Full exception text.
34465
+ durationMs:
34466
+ type: number
34467
+ format: double
34468
+ description: query_duration_ms before the failure.
34469
+ memoryUsageBytes:
34470
+ type: integer
34471
+ format: int64
34472
+ description: Memory usage in bytes.
34473
+ hostName:
34474
+ type: string
34475
+ description: ClickHouse server host that ran the query.
34476
+ clickhouseSQLAnalysis:
34477
+ type: object
34478
+ required:
34479
+ - collectedAt
34480
+ - status
34481
+ - slowestQueries
34482
+ - patterns
34483
+ - failures
34484
+ - sources
34485
+ properties:
34486
+ collectedAt:
34487
+ type: string
34488
+ description: Collection time in RFC3339 UTC.
34489
+ status:
34490
+ type: string
34491
+ description: available when system.query_log was collected, unavailable when query logging is disabled or the table is missing.
34492
+ unavailableReason:
34493
+ type: string
34494
+ description: Stable reason code when status is unavailable, for example query_log_unavailable.
34495
+ message:
34496
+ type: string
34497
+ description: Human-readable guidance when the analysis is unavailable.
34498
+ range:
34499
+ $ref: '#/components/schemas/clickhouseSQLAnalysisRange'
34500
+ summary:
34501
+ $ref: '#/components/schemas/clickhouseSQLSummary'
34502
+ slowestQueries:
34503
+ type: array
34504
+ description: Top initial queries ordered by query_duration_ms descending. Distributed child queries are excluded via is_initial_query = 1.
34505
+ items:
34506
+ $ref: '#/components/schemas/clickhouseSlowQuery'
34507
+ patterns:
34508
+ type: array
34509
+ description: Query patterns grouped by normalized_query_hash and ordered by the requested metric.
34510
+ items:
34511
+ $ref: '#/components/schemas/clickhouseQueryPattern'
34512
+ failures:
34513
+ type: array
34514
+ description: Failed queries (type = ExceptionWhileProcessing) ordered by event_time descending.
34515
+ items:
34516
+ $ref: '#/components/schemas/clickhouseFailedQuery'
34517
+ sources:
34518
+ type: array
34519
+ description: Per-source collection status.
34520
+ items:
34521
+ $ref: '#/components/schemas/clickhouseSource'
34522
+ clickhouseSpaceSummary:
34523
+ type: object
34524
+ properties:
34525
+ databaseCount:
34526
+ type: integer
34527
+ format: int64
34528
+ description: Number of databases with active parts.
34529
+ tableCount:
34530
+ type: integer
34531
+ format: int64
34532
+ description: Number of tables with active parts.
34533
+ totalBytes:
34534
+ type: integer
34535
+ format: int64
34536
+ description: Physical bytes_on_disk across all hosts.
34537
+ dataCompressedBytes:
34538
+ type: integer
34539
+ format: int64
34540
+ description: Sum of data_compressed_bytes.
34541
+ dataUncompressedBytes:
34542
+ type: integer
34543
+ format: int64
34544
+ description: Sum of data_uncompressed_bytes.
34545
+ compressionRatio:
34546
+ type: number
34547
+ format: double
34548
+ description: data_compressed_bytes / data_uncompressed_bytes. Lower is better; zero when uncompressed size is unknown.
34549
+ totalRows:
34550
+ type: integer
34551
+ format: int64
34552
+ description: Sum of active part rows across all hosts.
34553
+ activeParts:
34554
+ type: integer
34555
+ format: int64
34556
+ description: Number of active parts across all hosts.
34557
+ partitionCount:
34558
+ type: integer
34559
+ format: int64
34560
+ description: Sum of per-table partition counts. Replicated partitions can be counted more than once.
34561
+ warningTables:
34562
+ type: integer
34563
+ format: int64
34564
+ description: Tables whose active part count reached parts_to_delay_insert.
34565
+ criticalTables:
34566
+ type: integer
34567
+ format: int64
34568
+ description: Tables whose active part count reached parts_to_throw_insert.
34569
+ partsToDelayInsert:
34570
+ type: integer
34571
+ format: int64
34572
+ description: Effective parts_to_delay_insert from system.merge_tree_settings (default 150).
34573
+ partsToThrowInsert:
34574
+ type: integer
34575
+ format: int64
34576
+ description: Effective parts_to_throw_insert from system.merge_tree_settings (default 300).
34577
+ clickhouseDiskUsage:
34578
+ type: object
34579
+ properties:
34580
+ diskName:
34581
+ type: string
34582
+ description: ClickHouse disk name.
34583
+ hostName:
34584
+ type: string
34585
+ description: ClickHouse server host.
34586
+ bytesOnDisk:
34587
+ type: integer
34588
+ format: int64
34589
+ description: bytes_on_disk for this disk and host.
34590
+ dataCompressedBytes:
34591
+ type: integer
34592
+ format: int64
34593
+ description: data_compressed_bytes for this disk and host.
34594
+ dataUncompressedBytes:
34595
+ type: integer
34596
+ format: int64
34597
+ description: data_uncompressed_bytes for this disk and host.
34598
+ rows:
34599
+ type: integer
34600
+ format: int64
34601
+ description: Rows on this disk and host.
34602
+ activeParts:
34603
+ type: integer
34604
+ format: int64
34605
+ description: Active parts on this disk and host.
34606
+ clickhouseTableSpace:
34607
+ type: object
34608
+ properties:
34609
+ database:
34610
+ type: string
34611
+ description: Database name.
34612
+ table:
34613
+ type: string
34614
+ description: Table name.
34615
+ engine:
34616
+ type: string
34617
+ description: Table engine.
34618
+ bytesOnDisk:
34619
+ type: integer
34620
+ format: int64
34621
+ description: Physical bytes_on_disk across all hosts and disks.
34622
+ dataCompressedBytes:
34623
+ type: integer
34624
+ format: int64
34625
+ description: Sum of data_compressed_bytes.
34626
+ dataUncompressedBytes:
34627
+ type: integer
34628
+ format: int64
34629
+ description: Sum of data_uncompressed_bytes.
34630
+ compressionRatio:
34631
+ type: number
34632
+ format: double
34633
+ description: data_compressed_bytes / data_uncompressed_bytes.
34634
+ rows:
34635
+ type: integer
34636
+ format: int64
34637
+ description: Sum of active part rows.
34638
+ activeParts:
34639
+ type: integer
34640
+ format: int64
34641
+ description: Active part count used for the Too many parts risk check.
34642
+ partitionCount:
34643
+ type: integer
34644
+ format: int64
34645
+ description: Distinct partitions across disks and hosts.
34646
+ hosts:
34647
+ type: integer
34648
+ format: int64
34649
+ description: Number of hosts that own active parts for this table.
34650
+ lastModifiedAt:
34651
+ type: string
34652
+ description: Latest part modification time in RFC3339 UTC.
34653
+ risk:
34654
+ type: string
34655
+ description: normal, warning (parts >= parts_to_delay_insert) or critical (parts >= parts_to_throw_insert).
34656
+ disks:
34657
+ type: array
34658
+ description: Per-disk and per-host breakdown.
34659
+ items:
34660
+ $ref: '#/components/schemas/clickhouseDiskUsage'
34661
+ clickhousePartitionSpace:
34662
+ type: object
34663
+ properties:
34664
+ database:
34665
+ type: string
34666
+ description: Database name.
34667
+ table:
34668
+ type: string
34669
+ description: Table name.
34670
+ partitionId:
34671
+ type: string
34672
+ description: partition_id from system.parts.
34673
+ partition:
34674
+ type: string
34675
+ description: Human-readable partition expression.
34676
+ rows:
34677
+ type: integer
34678
+ format: int64
34679
+ description: Sum of rows across hosts.
34680
+ bytesOnDisk:
34681
+ type: integer
34682
+ format: int64
34683
+ description: Physical bytes_on_disk across hosts.
34684
+ dataCompressedBytes:
34685
+ type: integer
34686
+ format: int64
34687
+ description: Sum of data_compressed_bytes.
34688
+ dataUncompressedBytes:
34689
+ type: integer
34690
+ format: int64
34691
+ description: Sum of data_uncompressed_bytes.
34692
+ activeParts:
34693
+ type: integer
34694
+ format: int64
34695
+ description: Active part count across hosts.
34696
+ hosts:
34697
+ type: integer
34698
+ format: int64
34699
+ description: Number of hosts that own this partition.
34700
+ minDate:
34701
+ type: string
34702
+ description: Minimum min_date in the partition.
34703
+ maxDate:
34704
+ type: string
34705
+ description: Maximum max_date in the partition.
34706
+ clickhouseMerge:
34707
+ type: object
34708
+ properties:
34709
+ database:
34710
+ type: string
34711
+ description: Database name.
34712
+ table:
34713
+ type: string
34714
+ description: Table name.
34715
+ hostName:
34716
+ type: string
34717
+ description: ClickHouse server host running the merge.
34718
+ elapsedSeconds:
34719
+ type: number
34720
+ format: double
34721
+ description: Seconds elapsed since the merge started.
34722
+ progress:
34723
+ type: number
34724
+ format: double
34725
+ description: Merge progress (0-1).
34726
+ numParts:
34727
+ type: integer
34728
+ format: int64
34729
+ description: Number of source parts.
34730
+ resultPartName:
34731
+ type: string
34732
+ description: Resulting part name.
34733
+ partitionId:
34734
+ type: string
34735
+ description: Partition being merged.
34736
+ isMutation:
34737
+ type: boolean
34738
+ description: Whether this merge also applies a mutation.
34739
+ memoryUsageBytes:
34740
+ type: integer
34741
+ format: int64
34742
+ description: Memory usage in bytes.
34743
+ rowsRead:
34744
+ type: integer
34745
+ format: int64
34746
+ description: Rows read by the merge.
34747
+ rowsWritten:
34748
+ type: integer
34749
+ format: int64
34750
+ description: Rows written by the merge.
34751
+ totalSizeBytesCompressed:
34752
+ type: integer
34753
+ format: int64
34754
+ description: Compressed size of the source parts.
34755
+ clickhouseMutation:
34756
+ type: object
34757
+ properties:
34758
+ database:
34759
+ type: string
34760
+ description: Database name.
34761
+ table:
34762
+ type: string
34763
+ description: Table name.
34764
+ hostName:
34765
+ type: string
34766
+ description: ClickHouse server host running the mutation.
34767
+ mutationId:
34768
+ type: string
34769
+ description: Mutation identifier.
34770
+ command:
34771
+ type: string
34772
+ description: Mutation command (ALTER/UPDATE/DELETE) with string and numeric literals and comments masked as ?.
34773
+ createTime:
34774
+ type: string
34775
+ description: Mutation creation time in RFC3339 UTC.
34776
+ partsToDo:
34777
+ type: integer
34778
+ format: int64
34779
+ description: Parts still waiting to be mutated.
34780
+ latestFailedPart:
34781
+ type: string
34782
+ description: Most recent part that failed mutation.
34783
+ latestFailTime:
34784
+ type: string
34785
+ description: Most recent mutation failure time in RFC3339 UTC.
34786
+ latestFailReason:
34787
+ type: string
34788
+ description: Most recent mutation failure reason.
34789
+ clickhouseSpaceAnalysis:
34790
+ type: object
34791
+ required:
34792
+ - collectedAt
34793
+ - status
34794
+ - tables
34795
+ - partitions
34796
+ - merges
34797
+ - mutations
34798
+ - sources
34799
+ properties:
34800
+ collectedAt:
34801
+ type: string
34802
+ description: Collection time in RFC3339 UTC.
34803
+ status:
34804
+ type: string
34805
+ description: success when all sources were collected, partial when at least one best-effort source failed.
34806
+ database:
34807
+ type: string
34808
+ description: Database filter applied to the collection, empty when all databases are included.
34809
+ summary:
34810
+ $ref: '#/components/schemas/clickhouseSpaceSummary'
34811
+ tables:
34812
+ type: array
34813
+ description: Top tables ordered by physical bytes_on_disk. Totals are physical usage across all hosts, not deduplicated logical usage.
34814
+ items:
34815
+ $ref: '#/components/schemas/clickhouseTableSpace'
34816
+ partitions:
34817
+ type: array
34818
+ description: Top partitions ordered by physical bytes_on_disk.
34819
+ items:
34820
+ $ref: '#/components/schemas/clickhousePartitionSpace'
34821
+ merges:
34822
+ type: array
34823
+ description: In-progress background merges from system.merges ordered by elapsed time.
34824
+ items:
34825
+ $ref: '#/components/schemas/clickhouseMerge'
34826
+ mutations:
34827
+ type: array
34828
+ description: Unfinished mutations from system.mutations ordered by creation time.
34829
+ items:
34830
+ $ref: '#/components/schemas/clickhouseMutation'
34831
+ sources:
34832
+ type: array
34833
+ description: Per-source collection status.
34834
+ items:
34835
+ $ref: '#/components/schemas/clickhouseSource'
34836
+ clickhouseClusterHealthSummary:
34837
+ type: object
34838
+ properties:
34839
+ replicaCount:
34840
+ type: integer
34841
+ format: int64
34842
+ description: Number of replicated table replicas collected.
34843
+ nodeCount:
34844
+ type: integer
34845
+ format: int64
34846
+ description: Number of nodes in system.clusters.
34847
+ clusterCount:
34848
+ type: integer
34849
+ format: int64
34850
+ description: Number of distinct cluster names.
34851
+ totalReplicas:
34852
+ type: integer
34853
+ format: int64
34854
+ description: Sum of total_replicas across replicated tables.
34855
+ activeReplicas:
34856
+ type: integer
34857
+ format: int64
34858
+ description: Sum of active_replicas across replicated tables.
34859
+ readonlyReplicas:
34860
+ type: integer
34861
+ format: int64
34862
+ description: Replicas currently in readonly mode.
34863
+ sessionExpiredReplicas:
34864
+ type: integer
34865
+ format: int64
34866
+ description: Replicas whose Keeper session expired.
34867
+ maxAbsoluteDelaySeconds:
34868
+ type: number
34869
+ format: double
34870
+ description: Maximum absolute_delay in seconds.
34871
+ totalQueueSize:
34872
+ type: integer
34873
+ format: int64
34874
+ description: Sum of replication queue sizes.
34875
+ warningReplicas:
34876
+ type: integer
34877
+ format: int64
34878
+ description: Replicas classified as warning.
34879
+ criticalReplicas:
34880
+ type: integer
34881
+ format: int64
34882
+ description: Replicas classified as critical.
34883
+ unhealthyNodes:
34884
+ type: integer
34885
+ format: int64
34886
+ description: Nodes with connection errors, slowdowns or a non-zero estimated recovery time.
34887
+ clickhouseReplicaHealth:
34888
+ type: object
34889
+ properties:
34890
+ database:
34891
+ type: string
34892
+ description: Database name.
34893
+ table:
34894
+ type: string
34895
+ description: Table name.
34896
+ hostName:
34897
+ type: string
34898
+ description: ClickHouse server host that reported this replica.
34899
+ isReadonly:
34900
+ type: boolean
34901
+ description: Replica is in readonly mode. Usually indicates Keeper or network problems.
34902
+ isSessionExpired:
34903
+ type: boolean
34904
+ description: Keeper session expired.
34905
+ absoluteDelaySeconds:
34906
+ type: number
34907
+ format: double
34908
+ description: absolute_delay from system.replicas.
34909
+ queueSize:
34910
+ type: integer
34911
+ format: int64
34912
+ description: replication queue size.
34913
+ insertsInQueue:
34914
+ type: integer
34915
+ format: int64
34916
+ description: Number of inserts waiting in the replication queue.
34917
+ mergesInQueue:
34918
+ type: integer
34919
+ format: int64
34920
+ description: Number of merges waiting in the replication queue.
34921
+ futureParts:
34922
+ type: integer
34923
+ format: int64
34924
+ description: Number of future parts.
34925
+ partsToCheck:
34926
+ type: integer
34927
+ format: int64
34928
+ description: Number of parts to check.
34929
+ totalReplicas:
34930
+ type: integer
34931
+ format: int64
34932
+ description: total_replicas for the table.
34933
+ activeReplicas:
34934
+ type: integer
34935
+ format: int64
34936
+ description: active_replicas for the table.
34937
+ logMaxIndex:
34938
+ type: integer
34939
+ format: int64
34940
+ description: Maximum log index in Keeper.
34941
+ logPointer:
34942
+ type: integer
34943
+ format: int64
34944
+ description: Last applied log index.
34945
+ lastQueueUpdate:
34946
+ type: string
34947
+ description: Last replication queue update time in RFC3339 UTC.
34948
+ zookeeperPath:
34949
+ type: string
34950
+ description: Keeper path of the table.
34951
+ replicaName:
34952
+ type: string
34953
+ description: Replica name.
34954
+ replicaPath:
34955
+ type: string
34956
+ description: Replica path in Keeper.
34957
+ zookeeperException:
34958
+ type: string
34959
+ description: Last Keeper exception, empty when healthy.
34960
+ lastQueueUpdateException:
34961
+ type: string
34962
+ description: Last replication queue update exception, empty when healthy.
34963
+ risk:
34964
+ type: string
34965
+ description: normal, warning or critical.
34966
+ issues:
34967
+ type: array
34968
+ description: Detected issue codes such as readonly, session_expired, replication_delay, queue_backlog, missing_replicas, keeper_error or queue_update_error.
34969
+ items:
34970
+ type: string
34971
+ clickhouseClusterNode:
34972
+ type: object
34973
+ properties:
34974
+ cluster:
34975
+ type: string
34976
+ description: Cluster name.
34977
+ shardNum:
34978
+ type: integer
34979
+ format: int64
34980
+ description: Shard number.
34981
+ shardWeight:
34982
+ type: integer
34983
+ format: int64
34984
+ description: Shard weight.
34985
+ replicaNum:
34986
+ type: integer
34987
+ format: int64
34988
+ description: Replica number inside the shard.
34989
+ hostName:
34990
+ type: string
34991
+ description: Configured host name.
34992
+ hostAddress:
34993
+ type: string
34994
+ description: Configured host address.
34995
+ port:
34996
+ type: integer
34997
+ format: int64
34998
+ description: Configured TCP port.
34999
+ isLocal:
35000
+ type: boolean
35001
+ description: Whether this node is the connected node.
35002
+ user:
35003
+ type: string
35004
+ description: Configured user.
35005
+ defaultDatabase:
35006
+ type: string
35007
+ description: Configured default database.
35008
+ errorsCount:
35009
+ type: integer
35010
+ format: int64
35011
+ description: Connection errors observed for this node.
35012
+ slowdownsCount:
35013
+ type: integer
35014
+ format: int64
35015
+ description: Slowdown events observed for this node.
35016
+ estimatedRecoveryTime:
35017
+ type: integer
35018
+ format: int64
35019
+ description: Estimated recovery time in seconds, zero when the node is healthy.
35020
+ risk:
35021
+ type: string
35022
+ description: normal or warning.
35023
+ issues:
35024
+ type: array
35025
+ description: Detected issue codes such as connection_errors, slowdowns or estimated_recovery_time.
35026
+ items:
35027
+ type: string
35028
+ clickhouseClusterHealth:
35029
+ type: object
35030
+ required:
35031
+ - collectedAt
35032
+ - status
35033
+ - replicas
35034
+ - nodes
35035
+ - sources
35036
+ properties:
35037
+ collectedAt:
35038
+ type: string
35039
+ description: Collection time in RFC3339 UTC.
35040
+ status:
35041
+ type: string
35042
+ description: Collection status. success when every source was collected, partial when topology or replicas could only be partially read.
35043
+ overallStatus:
35044
+ type: string
35045
+ description: Derived health status. normal, warning or critical.
35046
+ clusterMode:
35047
+ type: string
35048
+ description: Detected deployment mode (standalone or cluster).
35049
+ summary:
35050
+ $ref: '#/components/schemas/clickhouseClusterHealthSummary'
35051
+ replicas:
35052
+ type: array
35053
+ description: Replicated tables ordered by risk, absolute delay and queue size.
35054
+ items:
35055
+ $ref: '#/components/schemas/clickhouseReplicaHealth'
35056
+ nodes:
35057
+ type: array
35058
+ description: Shard and replica topology from system.clusters on the connected node.
35059
+ items:
35060
+ $ref: '#/components/schemas/clickhouseClusterNode'
35061
+ sources:
35062
+ type: array
35063
+ description: Per-source collection status.
35064
+ items:
35065
+ $ref: '#/components/schemas/clickhouseSource'
33908
35066
  metricsQueryType:
33909
35067
  type: string
33910
35068
  enum: