| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-clickhouse |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: clickhouse |
| 7 | monitored_instance: |
| 8 | name: ClickHouse |
| 9 | link: https://clickhouse.com/ |
| 10 | icon_filename: clickhouse.svg |
| 11 | categories: |
| 12 | - data-collection.databases |
| 13 | keywords: |
| 14 | - database |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector retrieves performance data from ClickHouse for connections, queries, resources, replication, IO, and data operations (inserts, selects, merges) using HTTP requests and ClickHouse system tables. It monitors your ClickHouse server's health and activity. |
| 24 | method_description: | |
| 25 | It sends HTTP requests to the ClickHouse [HTTP interface](https://clickhouse.com/docs/en/interfaces/http), executing SELECT queries to retrieve data from various system tables. |
| 26 | Specifically, it collects metrics from the following tables: |
| 27 | |
| 28 | - system.metrics |
| 29 | - system.async_metrics |
| 30 | - system.events |
| 31 | - system.disks |
| 32 | - system.parts |
| 33 | - system.processes |
| 34 | supported_platforms: |
| 35 | include: [] |
| 36 | exclude: [] |
| 37 | multi_instance: true |
| 38 | additional_permissions: |
| 39 | description: "" |
| 40 | default_behavior: |
| 41 | auto_detection: |
| 42 | description: | |
| 43 | By default, it detects ClickHouse instances running on localhost that are listening on port 8123. |
| 44 | On startup, it tries to collect metrics from: |
| 45 | |
| 46 | - http://127.0.0.1:8123 |
| 47 | limits: |
| 48 | description: "" |
| 49 | performance_impact: |
| 50 | description: "" |
| 51 | setup: |
| 52 | prerequisites: |
| 53 | list: [] |
| 54 | configuration: |
| 55 | file: |
| 56 | name: go.d/clickhouse.conf |
| 57 | options: |
| 58 | description: | |
| 59 | The following options can be defined globally: update_every, autodetection_retry. |
| 60 | folding: |
| 61 | title: Config options |
| 62 | enabled: true |
| 63 | list: |
| 64 | - name: update_every |
| 65 | description: Data collection interval (seconds). |
| 66 | default_value: 1 |
| 67 | required: false |
| 68 | group: Collection |
| 69 | - name: autodetection_retry |
| 70 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 71 | default_value: 0 |
| 72 | required: false |
| 73 | group: Collection |
| 74 | |
| 75 | - name: url |
| 76 | description: Target endpoint URL. |
| 77 | default_value: http://127.0.0.1:8123 |
| 78 | required: true |
| 79 | group: Target |
| 80 | - name: timeout |
| 81 | description: HTTP request timeout (seconds). |
| 82 | default_value: 1 |
| 83 | required: false |
| 84 | group: Target |
| 85 | |
| 86 | - name: username |
| 87 | description: Username for Basic HTTP authentication. |
| 88 | default_value: "" |
| 89 | required: false |
| 90 | group: HTTP Auth |
| 91 | - name: password |
| 92 | description: Password for Basic HTTP authentication. |
| 93 | default_value: "" |
| 94 | required: false |
| 95 | group: HTTP Auth |
| 96 | - name: bearer_token_file |
| 97 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 98 | default_value: "" |
| 99 | required: false |
| 100 | group: HTTP Auth |
| 101 | |
| 102 | - name: tls_skip_verify |
| 103 | description: Skip TLS certificate and hostname verification (insecure). |
| 104 | default_value: no |
| 105 | required: false |
| 106 | group: TLS |
| 107 | - name: tls_ca |
| 108 | description: Path to CA bundle used to validate the server certificate. |
| 109 | default_value: "" |
| 110 | required: false |
| 111 | group: TLS |
| 112 | - name: tls_cert |
| 113 | description: Path to client TLS certificate (for mTLS). |
| 114 | default_value: "" |
| 115 | required: false |
| 116 | group: TLS |
| 117 | - name: tls_key |
| 118 | description: Path to client TLS private key (for mTLS). |
| 119 | default_value: "" |
| 120 | required: false |
| 121 | group: TLS |
| 122 | |
| 123 | - name: proxy_url |
| 124 | description: HTTP proxy URL. |
| 125 | default_value: "" |
| 126 | required: false |
| 127 | group: Proxy |
| 128 | - name: proxy_username |
| 129 | description: Username for proxy Basic HTTP authentication. |
| 130 | default_value: "" |
| 131 | required: false |
| 132 | group: Proxy |
| 133 | - name: proxy_password |
| 134 | description: Password for proxy Basic HTTP authentication. |
| 135 | default_value: "" |
| 136 | required: false |
| 137 | group: Proxy |
| 138 | |
| 139 | - name: method |
| 140 | description: HTTP method to use. |
| 141 | default_value: "GET" |
| 142 | required: false |
| 143 | group: Request |
| 144 | - name: body |
| 145 | description: Request body (e.g., for POST/PUT). |
| 146 | default_value: "" |
| 147 | required: false |
| 148 | group: Request |
| 149 | - name: headers |
| 150 | description: "Additional HTTP headers (one per line as key: value)." |
| 151 | default_value: "" |
| 152 | required: false |
| 153 | group: Request |
| 154 | - name: not_follow_redirects |
| 155 | description: Do not follow HTTP redirects. |
| 156 | default_value: no |
| 157 | required: false |
| 158 | group: Request |
| 159 | - name: force_http2 |
| 160 | description: Force HTTP/2 (including h2c over TCP). |
| 161 | default_value: no |
| 162 | required: false |
| 163 | group: Request |
| 164 | |
| 165 | - name: functions.top_queries.disabled |
| 166 | description: Disable the [top-queries](#top-queries) function. |
| 167 | default_value: false |
| 168 | required: false |
| 169 | group: Functions |
| 170 | - name: functions.top_queries.timeout |
| 171 | description: Query timeout (seconds). Uses collector timeout if not set. |
| 172 | default_value: "" |
| 173 | required: false |
| 174 | group: Functions |
| 175 | - name: functions.top_queries.limit |
| 176 | description: Maximum number of queries to return. |
| 177 | default_value: 500 |
| 178 | required: false |
| 179 | group: Functions |
| 180 | |
| 181 | - name: vnode |
| 182 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 183 | default_value: "" |
| 184 | required: false |
| 185 | group: Virtual Node |
| 186 | examples: |
| 187 | folding: |
| 188 | title: Config |
| 189 | enabled: true |
| 190 | list: |
| 191 | - name: Basic |
| 192 | folding: |
| 193 | enabled: false |
| 194 | description: A basic example configuration. |
| 195 | config: | |
| 196 | jobs: |
| 197 | - name: local |
| 198 | url: http://127.0.0.1:8123 |
| 199 | - name: HTTP authentication |
| 200 | description: Basic HTTP authentication. |
| 201 | config: | |
| 202 | jobs: |
| 203 | - name: local |
| 204 | url: http://127.0.0.1:8123 |
| 205 | username: username |
| 206 | password: password |
| 207 | - name: HTTPS with self-signed certificate |
| 208 | description: ClickHouse with enabled HTTPS and self-signed certificate. |
| 209 | config: | |
| 210 | jobs: |
| 211 | - name: local |
| 212 | url: https://127.0.0.1:8123 |
| 213 | tls_skip_verify: yes |
| 214 | - name: Multi-instance |
| 215 | description: | |
| 216 | > **Note**: When you define multiple jobs, their names must be unique. |
| 217 | |
| 218 | Collecting metrics from local and remote instances. |
| 219 | config: | |
| 220 | jobs: |
| 221 | - name: local |
| 222 | url: http://127.0.0.1:8123 |
| 223 | |
| 224 | - name: remote |
| 225 | url: http://192.0.2.1:8123 |
| 226 | troubleshooting: |
| 227 | problems: |
| 228 | list: [] |
| 229 | alerts: |
| 230 | - name: clickhouse_restarted |
| 231 | metric: clickhouse.uptime |
| 232 | info: ClickHouse has recently been restarted |
| 233 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 234 | - name: clickhouse_queries_preempted |
| 235 | metric: clickhouse.queries_preempted |
| 236 | info: ClickHouse has queries that are stopped and waiting due to priority setting |
| 237 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 238 | - name: clickhouse_long_running_query |
| 239 | metric: clickhouse.longest_running_query_time |
| 240 | info: ClickHouse has a long-running query exceeding the threshold |
| 241 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 242 | - name: clickhouse_rejected_inserts |
| 243 | metric: clickhouse.rejected_inserts |
| 244 | info: ClickHouse has INSERT queries that are rejected due to high number of active data parts for partition in a MergeTree |
| 245 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 246 | - name: clickhouse_delayed_inserts |
| 247 | metric: clickhouse.delayed_inserts |
| 248 | info: ClickHouse has INSERT queries that are throttled due to high number of active data parts for partition in a MergeTree |
| 249 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 250 | - name: clickhouse_replication_lag |
| 251 | metric: clickhouse.replicas_max_absolute_delay |
| 252 | info: ClickHouse is experiencing replication lag greater than 5 minutes |
| 253 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 254 | - name: clickhouse_replicated_readonly_tables |
| 255 | metric: clickhouse.replicated_readonly_tables |
| 256 | info: ClickHouse has replicated tables in readonly state due to ZooKeeper session loss/startup without ZooKeeper configured |
| 257 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 258 | - name: clickhouse_max_part_count_for_partition |
| 259 | metric: clickhouse.max_part_count_for_partition |
| 260 | info: ClickHouse high number of parts per partition |
| 261 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 262 | - name: clickhouse_distributed_connections_failures |
| 263 | metric: clickhouse.distributed_connections_fail_exhausted_retries |
| 264 | info: ClickHouse has failed distributed connections after exhausting all retry attempts |
| 265 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 266 | - name: clickhouse_distributed_files_to_insert |
| 267 | metric: clickhouse.distributed_files_to_insert |
| 268 | info: ClickHouse high number of pending files to process for asynchronous insertion into Distributed tables |
| 269 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf |
| 270 | functions: |
| 271 | description: | |
| 272 | This collector exposes real-time functions for interactive troubleshooting in the Live tab. |
| 273 | list: |
| 274 | - id: top-queries |
| 275 | name: Top Queries |
| 276 | description: | |
| 277 | Retrieves and aggregates SQL query performance metrics from ClickHouse [system.query_log](https://clickhouse.com/docs/en/operations/system-tables/query_log) table. |
| 278 | |
| 279 | This function queries the `system.query_log` table, which contains information about executed queries including timing, resource usage, and execution statistics. Queries are grouped by their normalized hash (`normalized_query_hash`) to aggregate statistics for identical query patterns with different literal values. |
| 280 | |
| 281 | Use cases: |
| 282 | - Identify slow queries that consume the most execution time |
| 283 | - Find frequently executed queries that may benefit from optimization |
| 284 | - Analyze I/O patterns by examining read/written rows and bytes |
| 285 | |
| 286 | Query text is truncated at 4096 characters for display purposes. |
| 287 | parameters: |
| 288 | - id: __sort |
| 289 | name: Filter By |
| 290 | description: Select the primary sort column. The available options include total execution time, number of calls, rows read, and more. Defaults to total execution time to focus on most resource-intensive queries. |
| 291 | type: select |
| 292 | required: true |
| 293 | default: totalTime |
| 294 | options: [] |
| 295 | returns: |
| 296 | description: Aggregated query statistics from `system.query_log`, grouped by normalized query hash. Each row represents a unique query pattern with cumulative metrics across all executions. |
| 297 | columns: |
| 298 | - name: Query ID |
| 299 | type: string |
| 300 | unit: "" |
| 301 | visibility: hidden |
| 302 | description: "Unique hash identifier for the normalized query pattern. Queries with identical structure but different literal values share the same hash." |
| 303 | - name: Query |
| 304 | type: string |
| 305 | unit: "" |
| 306 | description: "SQL query text from one of the executions. Truncated to 4096 characters. Use this to identify the actual SQL being executed." |
| 307 | - name: Database |
| 308 | type: string |
| 309 | unit: "" |
| 310 | description: "Database name where the query was executed. Empty string for queries without a database context or system queries." |
| 311 | - name: User |
| 312 | type: string |
| 313 | unit: "" |
| 314 | description: "ClickHouse user that executed the query. Useful for identifying query sources and implementing per-user resource monitoring." |
| 315 | - name: Calls |
| 316 | type: integer |
| 317 | unit: "" |
| 318 | description: "Total number of times this query pattern has been executed. High values indicate frequently run queries that impact overall server load." |
| 319 | - name: Total Time |
| 320 | type: duration |
| 321 | unit: "milliseconds" |
| 322 | description: "Cumulative execution time across all executions. High values indicate queries that consume significant server resources over time." |
| 323 | - name: Avg Time |
| 324 | type: duration |
| 325 | unit: "milliseconds" |
| 326 | description: "Average execution time per query run. Use this to compare typical performance across different query patterns." |
| 327 | - name: Min Time |
| 328 | type: duration |
| 329 | unit: "milliseconds" |
| 330 | visibility: hidden |
| 331 | description: "Minimum execution time observed for a single execution. Helps identify best-case query performance." |
| 332 | - name: Max Time |
| 333 | type: duration |
| 334 | unit: "milliseconds" |
| 335 | visibility: hidden |
| 336 | description: "Maximum execution time observed for a single execution. Large gaps between min and max may indicate data skew or resource contention." |
| 337 | - name: Read Rows |
| 338 | type: integer |
| 339 | unit: "" |
| 340 | description: "Total number of rows read from storage across all executions. High values suggest queries scanning large amounts of data that may benefit from better filtering or indexing." |
| 341 | - name: Read Bytes |
| 342 | type: integer |
| 343 | unit: "" |
| 344 | description: "Total bytes read from storage across all executions. Indicates I/O load and data transfer volume for the query pattern." |
| 345 | - name: Written Rows |
| 346 | type: integer |
| 347 | unit: "" |
| 348 | visibility: hidden |
| 349 | description: "Total number of rows written across all executions. Relevant for INSERT, CREATE, or materialized view queries." |
| 350 | - name: Written Bytes |
| 351 | type: integer |
| 352 | unit: "" |
| 353 | visibility: hidden |
| 354 | description: "Total bytes written across all executions. Indicates storage impact of write operations." |
| 355 | - name: Result Rows |
| 356 | type: integer |
| 357 | unit: "" |
| 358 | description: "Total number of rows returned to clients across all executions. A high ratio of read rows to result rows indicates filtering or aggregation happening on large datasets." |
| 359 | - name: Result Bytes |
| 360 | type: integer |
| 361 | unit: "" |
| 362 | visibility: hidden |
| 363 | description: "Total bytes returned to clients across all executions. Large values may indicate queries returning more data than necessary." |
| 364 | - name: Max Memory |
| 365 | type: float |
| 366 | unit: "" |
| 367 | visibility: hidden |
| 368 | description: "Maximum memory used during any single execution. High values may indicate queries at risk of hitting memory limits under load." |
| 369 | performance: | |
| 370 | Queries `system.query_log` table and aggregates by `normalized_query_hash`:<br/>• On busy systems with high query throughput, the table can grow large<br/>• Default limit of 500 rows balances usefulness with performance |
| 371 | security: | |
| 372 | Query text may contain unmasked literal values including potentially sensitive data:<br/>• Personal information in query parameters<br/>• Business data and internal identifiers<br/>• Access should be restricted to authorized personnel only |
| 373 | prerequisites: |
| 374 | list: |
| 375 | - title: Grant access to `system.query_log` |
| 376 | description: | |
| 377 | Ensure the Netdata user can read `system.query_log` on the target ClickHouse instance. |
| 378 | |
| 379 | 1. Verify `query_log` is enabled (enabled by default): |
| 380 | |
| 381 | ```sql |
| 382 | SELECT * FROM system.query_log LIMIT 1; |
| 383 | ``` |
| 384 | |
| 385 | 2. If using a dedicated monitoring user, grant SELECT access: |
| 386 | |
| 387 | ```sql |
| 388 | GRANT SELECT ON system.query_log TO netdata_user; |
| 389 | ``` |
| 390 | |
| 391 | :::info |
| 392 | |
| 393 | - The `query_log` table is enabled by default in ClickHouse |
| 394 | - Only queries with `type='QueryFinish'` are included in the results |
| 395 | - The `normalized_query_hash` column is used for grouping when available |
| 396 | |
| 397 | ::: |
| 398 | availability: | |
| 399 | Available when:<br/>• The collector has successfully connected to ClickHouse<br/>• `system.query_log` table is accessible<br/>• Returns HTTP 503 if `system.query_log` is not accessible<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 504 if the query times out |
| 400 | require_cloud: true |
| 401 | metrics: |
| 402 | folding: |
| 403 | title: Metrics |
| 404 | enabled: false |
| 405 | description: "" |
| 406 | availability: [] |
| 407 | scopes: |
| 408 | - name: global |
| 409 | description: These metrics refer to the entire monitored application. |
| 410 | labels: [] |
| 411 | metrics: |
| 412 | - name: clickhouse.connections |
| 413 | description: Connections |
| 414 | unit: connections |
| 415 | chart_type: line |
| 416 | dimensions: |
| 417 | - name: tcp |
| 418 | - name: http |
| 419 | - name: mysql |
| 420 | - name: postgresql |
| 421 | - name: interserver |
| 422 | - name: clickhouse.slow_reads |
| 423 | description: Slow reads from a file |
| 424 | unit: reads/s |
| 425 | chart_type: line |
| 426 | dimensions: |
| 427 | - name: slow |
| 428 | - name: clickhouse.read_backoff |
| 429 | description: Read backoff events |
| 430 | unit: events/s |
| 431 | chart_type: line |
| 432 | dimensions: |
| 433 | - name: read_backoff |
| 434 | - name: clickhouse.memory_usage |
| 435 | description: Memory usage |
| 436 | unit: bytes |
| 437 | chart_type: area |
| 438 | dimensions: |
| 439 | - name: used |
| 440 | - name: clickhouse.running_queries |
| 441 | description: Running queries |
| 442 | unit: queries |
| 443 | chart_type: line |
| 444 | dimensions: |
| 445 | - name: running |
| 446 | - name: clickhouse.queries_preempted |
| 447 | description: Queries waiting due to priority |
| 448 | unit: queries |
| 449 | chart_type: line |
| 450 | dimensions: |
| 451 | - name: preempted |
| 452 | - name: clickhouse.queries |
| 453 | description: Queries |
| 454 | unit: queries/s |
| 455 | chart_type: stacked |
| 456 | dimensions: |
| 457 | - name: successful |
| 458 | - name: failed |
| 459 | - name: clickhouse.select_queries |
| 460 | description: Select queries |
| 461 | unit: selects/s |
| 462 | chart_type: stacked |
| 463 | dimensions: |
| 464 | - name: successful |
| 465 | - name: failed |
| 466 | - name: clickhouse.insert_queries |
| 467 | description: Insert queries |
| 468 | unit: inserts/s |
| 469 | chart_type: stacked |
| 470 | dimensions: |
| 471 | - name: successful |
| 472 | - name: failed |
| 473 | - name: clickhouse.queries_memory_limit_exceeded |
| 474 | description: Memory limit exceeded for query |
| 475 | unit: queries/s |
| 476 | chart_type: line |
| 477 | dimensions: |
| 478 | - name: mem_limit_exceeded |
| 479 | - name: clickhouse.longest_running_query_time |
| 480 | description: Longest running query time |
| 481 | unit: seconds |
| 482 | chart_type: line |
| 483 | dimensions: |
| 484 | - name: longest_query_time |
| 485 | - name: clickhouse.queries_latency |
| 486 | description: Queries latency |
| 487 | unit: microseconds |
| 488 | chart_type: line |
| 489 | dimensions: |
| 490 | - name: queries_time |
| 491 | - name: clickhouse.select_queries_latency |
| 492 | description: Select queries latency |
| 493 | unit: microseconds |
| 494 | chart_type: line |
| 495 | dimensions: |
| 496 | - name: selects_time |
| 497 | - name: clickhouse.insert_queries_latency |
| 498 | description: Insert queries latency |
| 499 | unit: microseconds |
| 500 | chart_type: line |
| 501 | dimensions: |
| 502 | - name: inserts_time |
| 503 | - name: clickhouse.io |
| 504 | description: Read and written data |
| 505 | unit: bytes/s |
| 506 | chart_type: area |
| 507 | dimensions: |
| 508 | - name: reads |
| 509 | - name: writes |
| 510 | - name: clickhouse.iops |
| 511 | description: Read and write operations |
| 512 | unit: ops/s |
| 513 | chart_type: line |
| 514 | dimensions: |
| 515 | - name: reads |
| 516 | - name: writes |
| 517 | - name: clickhouse.io_errors |
| 518 | description: Read and write errors |
| 519 | unit: errors/s |
| 520 | chart_type: line |
| 521 | dimensions: |
| 522 | - name: read |
| 523 | - name: write |
| 524 | - name: clickhouse.io_seeks |
| 525 | description: lseek function calls |
| 526 | unit: ops/s |
| 527 | chart_type: line |
| 528 | dimensions: |
| 529 | - name: lseek |
| 530 | - name: clickhouse.io_file_opens |
| 531 | description: File opens |
| 532 | unit: ops/s |
| 533 | chart_type: line |
| 534 | dimensions: |
| 535 | - name: file_open |
| 536 | - name: clickhouse.replicated_parts_current_activity |
| 537 | description: Replicated parts current activity |
| 538 | unit: parts |
| 539 | chart_type: line |
| 540 | dimensions: |
| 541 | - name: fetch |
| 542 | - name: send |
| 543 | - name: check |
| 544 | - name: clickhouse.replicas_max_absolute_dela |
| 545 | description: Replicas max absolute delay |
| 546 | unit: seconds |
| 547 | chart_type: line |
| 548 | dimensions: |
| 549 | - name: replication_delay |
| 550 | - name: clickhouse.replicated_readonly_tables |
| 551 | description: Replicated tables in readonly state |
| 552 | unit: tables |
| 553 | chart_type: line |
| 554 | dimensions: |
| 555 | - name: read_only |
| 556 | - name: clickhouse.replicated_data_loss |
| 557 | description: Replicated data loss |
| 558 | unit: events |
| 559 | chart_type: line |
| 560 | dimensions: |
| 561 | - name: data_loss |
| 562 | - name: clickhouse.replicated_part_fetches |
| 563 | description: Replicated part fetches |
| 564 | unit: fetches/s |
| 565 | chart_type: line |
| 566 | dimensions: |
| 567 | - name: successful |
| 568 | - name: failed |
| 569 | - name: clickhouse.inserted_rows |
| 570 | description: Inserted rows |
| 571 | unit: rows/s |
| 572 | chart_type: line |
| 573 | dimensions: |
| 574 | - name: inserted |
| 575 | - name: clickhouse.inserted_bytes |
| 576 | description: Inserted data |
| 577 | unit: bytes/s |
| 578 | chart_type: area |
| 579 | dimensions: |
| 580 | - name: inserted |
| 581 | - name: clickhouse.rejected_inserts |
| 582 | description: Rejected inserts |
| 583 | unit: inserts/s |
| 584 | chart_type: line |
| 585 | dimensions: |
| 586 | - name: rejected |
| 587 | - name: clickhouse.delayed_inserts |
| 588 | description: Delayed inserts |
| 589 | unit: inserts/s |
| 590 | chart_type: line |
| 591 | dimensions: |
| 592 | - name: delayed |
| 593 | - name: clickhouse.delayed_inserts_throttle_time |
| 594 | description: Delayed inserts throttle time |
| 595 | unit: milliseconds |
| 596 | chart_type: line |
| 597 | dimensions: |
| 598 | - name: delayed_inserts_throttle_time |
| 599 | - name: clickhouse.selected_bytes |
| 600 | description: Selected data |
| 601 | unit: bytes/s |
| 602 | chart_type: area |
| 603 | dimensions: |
| 604 | - name: selected |
| 605 | - name: clickhouse.selected_rows |
| 606 | description: Selected rows |
| 607 | unit: rows/s |
| 608 | chart_type: line |
| 609 | dimensions: |
| 610 | - name: selected |
| 611 | - name: clickhouse.selected_parts |
| 612 | description: Selected parts |
| 613 | unit: parts/s |
| 614 | chart_type: line |
| 615 | dimensions: |
| 616 | - name: selected |
| 617 | - name: clickhouse.selected_ranges |
| 618 | description: Selected ranges |
| 619 | unit: ranges/s |
| 620 | chart_type: line |
| 621 | dimensions: |
| 622 | - name: selected |
| 623 | - name: clickhouse.selected_marks |
| 624 | description: Selected marks |
| 625 | unit: marks/s |
| 626 | chart_type: line |
| 627 | dimensions: |
| 628 | - name: selected |
| 629 | - name: clickhouse.merges |
| 630 | description: Merge operations |
| 631 | unit: ops/s |
| 632 | chart_type: line |
| 633 | dimensions: |
| 634 | - name: merge |
| 635 | - name: clickhouse.merges_latency |
| 636 | description: Time spent for background merges |
| 637 | unit: milliseconds |
| 638 | chart_type: line |
| 639 | dimensions: |
| 640 | - name: merges_time |
| 641 | - name: clickhouse.merged_uncompressed_bytes |
| 642 | description: Uncompressed data read for background merges |
| 643 | unit: bytes/s |
| 644 | chart_type: area |
| 645 | dimensions: |
| 646 | - name: merged_uncompressed |
| 647 | - name: clickhouse.merged_rows |
| 648 | description: Merged rows |
| 649 | unit: rows/s |
| 650 | chart_type: line |
| 651 | dimensions: |
| 652 | - name: merged |
| 653 | - name: clickhouse.merge_tree_data_writer_inserted_rows |
| 654 | description: Rows INSERTed to MergeTree tables |
| 655 | unit: rows/s |
| 656 | chart_type: line |
| 657 | dimensions: |
| 658 | - name: inserted |
| 659 | - name: clickhouse.merge_tree_data_writer_uncompressed_bytes |
| 660 | description: Data INSERTed to MergeTree tables |
| 661 | unit: bytes/s |
| 662 | chart_type: area |
| 663 | dimensions: |
| 664 | - name: inserted |
| 665 | - name: clickhouse.merge_tree_data_writer_compressed_bytes |
| 666 | description: Data written to disk for data INSERTed to MergeTree tables |
| 667 | unit: bytes/s |
| 668 | chart_type: area |
| 669 | dimensions: |
| 670 | - name: written |
| 671 | - name: clickhouse.uncompressed_cache_requests |
| 672 | description: Uncompressed cache requests |
| 673 | unit: requests/s |
| 674 | chart_type: line |
| 675 | dimensions: |
| 676 | - name: hits |
| 677 | - name: misses |
| 678 | - name: clickhouse.mark_cache_requests |
| 679 | description: Mark cache requests |
| 680 | unit: requests/s |
| 681 | chart_type: line |
| 682 | dimensions: |
| 683 | - name: hits |
| 684 | - name: misses |
| 685 | - name: clickhouse.max_part_count_for_partition |
| 686 | description: Max part count for partition |
| 687 | unit: parts |
| 688 | chart_type: line |
| 689 | dimensions: |
| 690 | - name: max_parts_partition |
| 691 | - name: clickhouse.parts_count |
| 692 | description: Parts |
| 693 | unit: parts |
| 694 | chart_type: line |
| 695 | dimensions: |
| 696 | - name: temporary |
| 697 | - name: pre_active |
| 698 | - name: active |
| 699 | - name: deleting |
| 700 | - name: delete_on_destroy |
| 701 | - name: outdated |
| 702 | - name: wide |
| 703 | - name: compact |
| 704 | - name: distributed_connections |
| 705 | description: Active distributed connection |
| 706 | unit: connections |
| 707 | chart_type: line |
| 708 | dimensions: |
| 709 | - name: active |
| 710 | - name: distributed_connections_attempts |
| 711 | description: Distributed connection attempts |
| 712 | unit: attempts/s |
| 713 | chart_type: line |
| 714 | dimensions: |
| 715 | - name: connection |
| 716 | - name: distributed_connections_fail_retries |
| 717 | description: Distributed connection fails with retry |
| 718 | unit: fails/s |
| 719 | chart_type: line |
| 720 | dimensions: |
| 721 | - name: connection_retry |
| 722 | - name: distributed_connections_fail_exhausted_retries |
| 723 | description: Distributed connection fails after all retries finished |
| 724 | unit: fails/s |
| 725 | chart_type: line |
| 726 | dimensions: |
| 727 | - name: connection_retry_exhausted |
| 728 | - name: distributed_files_to_insert |
| 729 | description: Pending files to process for asynchronous insertion into Distributed tables |
| 730 | unit: files |
| 731 | chart_type: line |
| 732 | dimensions: |
| 733 | - name: pending_insertions |
| 734 | - name: distributed_rejected_inserts |
| 735 | description: Rejected INSERTs to a Distributed table |
| 736 | unit: inserts/s |
| 737 | chart_type: line |
| 738 | dimensions: |
| 739 | - name: rejected |
| 740 | - name: distributed_delayed_inserts |
| 741 | description: Delayed INSERTs to a Distributed table |
| 742 | unit: inserts/s |
| 743 | chart_type: line |
| 744 | dimensions: |
| 745 | - name: delayed |
| 746 | - name: distributed_delayed_inserts_latency |
| 747 | description: Time spent while the INSERT of a block to a Distributed table was throttled |
| 748 | unit: milliseconds |
| 749 | chart_type: line |
| 750 | dimensions: |
| 751 | - name: delayed_time |
| 752 | - name: distributed_sync_insertion_timeout_exceeded |
| 753 | description: Distributed table sync insertions timeouts |
| 754 | unit: timeouts/s |
| 755 | chart_type: line |
| 756 | dimensions: |
| 757 | - name: sync_insertion |
| 758 | - name: distributed_async_insertions_failures |
| 759 | description: Distributed table async insertion failures |
| 760 | unit: failures/s |
| 761 | chart_type: line |
| 762 | dimensions: |
| 763 | - name: async_insertions |
| 764 | - name: clickhouse.uptime |
| 765 | description: Uptime |
| 766 | unit: seconds |
| 767 | chart_type: line |
| 768 | dimensions: |
| 769 | - name: uptime |
| 770 | - name: disk |
| 771 | description: These metrics refer to the Disk. |
| 772 | labels: |
| 773 | - name: disk_name |
| 774 | description: Name of the disk as defined in the [server configuration](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-multiple-volumes_configure). |
| 775 | metrics: |
| 776 | - name: clickhouse.disk_space_usage |
| 777 | description: Disk space usage |
| 778 | unit: bytes |
| 779 | chart_type: stacked |
| 780 | dimensions: |
| 781 | - name: free |
| 782 | - name: used |
| 783 | - name: table |
| 784 | description: These metrics refer to the Database Table. |
| 785 | labels: |
| 786 | - name: database |
| 787 | description: Name of the database. |
| 788 | - name: table |
| 789 | description: Name of the table. |
| 790 | metrics: |
| 791 | - name: clickhouse.database_table_size |
| 792 | description: Table size |
| 793 | unit: bytes |
| 794 | chart_type: area |
| 795 | dimensions: |
| 796 | - name: size |
| 797 | - name: clickhouse.database_table_parts |
| 798 | description: Table parts |
| 799 | unit: parts |
| 800 | chart_type: line |
| 801 | dimensions: |
| 802 | - name: parts |
| 803 | - name: clickhouse.database_table_rows |
| 804 | description: Table rows |
| 805 | unit: rows |
| 806 | chart_type: line |
| 807 | dimensions: |
| 808 | - name: rows |