+# Examples: +#
+# "PT20.345S" -- parses as "20.345 seconds" +# "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) +# "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) +# "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds) +# "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes" +# "P-6H3M" -- parses as "-6 hours and +3 minutes" +# "-P6H3M" -- parses as "-6 hours and -3 minutes" +# "-P-6H+3M" -- parses as "+6 hours and -3 minutes" +#+filter: "{ tags -> tags.job_name == 'clickhouse-monitoring' }" # The OpenTelemetry job name +expSuffix: tag({tags -> tags.host_name = 'clickhouse::' + tags.host_name}).instance(['host_name'], ['service_instance_id'], Layer.CLICKHOUSE) +metricPrefix: meter_clickhouse +metricsRules: + # Version of the server in a single integer number in base-1000. + - name: instance_version + exp: ClickHouseMetrics_VersionInteger + # CPU time spent seen by OS. + - name: instance_cpu_usage + exp: ClickHouseProfileEvents_OSCPUVirtualTimeMicroseconds.increase('PT1M')/60 + # The percentage of memory (bytes) allocated by the server. + - name: instance_memory_usage + exp: ClickHouseMetrics_MemoryTracking / ClickHouseAsyncMetrics_OSMemoryTotal * 100 + # The percentage of memory available to be used by programs. + - name: instance_memory_available + exp: ClickHouseAsyncMetrics_OSMemoryAvailable / ClickHouseAsyncMetrics_OSMemoryTotal * 100 + # The server uptime in seconds. It includes the time spent for server initialization before accepting connections. + - name: instance_uptime + exp: ClickHouseAsyncMetrics_Uptime + # Number of files opened per minute. + - name: instance_file_open + exp: ClickHouseProfileEvents_FileOpen.increase('PT1M') + # Network + # Number of connections to TCP server. + - name: instance_tcp_connections + exp: ClickHouseMetrics_TCPConnection + # Number of client connections using MySQL protocol. + - name: instance_mysql_connections + exp: ClickHouseMetrics_MySQLConnection + # Number of connections to HTTP server. + - name: instance_http_connections + exp: ClickHouseMetrics_HTTPConnection + # Number of connections from other replicas to fetch parts. + - name: instance_interserver_connections + exp: ClickHouseMetrics_InterserverConnection + # Number of client connections using PostgreSQL protocol. + - name: instance_postgresql_connections + exp: ClickHouseMetrics_PostgreSQLConnection + # Total number of bytes received from network. + - name: instance_network_receive_bytes + exp: ClickHouseProfileEvents_NetworkReceiveBytes.increase('PT1M') + # Total number of bytes send to network. + - name: instance_network_send_bytes + exp: ClickHouseProfileEvents_NetworkSendBytes.increase('PT1M') + # Query + # Number of executing queries + - name: instance_query + exp: ClickHouseProfileEvents_Query.increase('PT1M') + # Number of executing queries, but only for SELECT queries. + - name: instance_query_select + exp: ClickHouseProfileEvents_SelectQuery.increase('PT1M') + # Number of executing queries, but only for INSERT queries. + - name: instance_query_insert + exp: ClickHouseProfileEvents_InsertQuery.increase('PT1M') + # Number of SELECT queries per second. + - name: instance_query_select_rate + exp: ClickHouseProfileEvents_SelectQuery.rate('PT1M') + # Number of INSERT queries per second. + - name: instance_query_insert_rate + exp: ClickHouseProfileEvents_InsertQuery.rate('PT1M') + # Total time of all queries + - name: instance_querytime_microseconds + exp: ClickHouseProfileEvents_QueryTimeMicroseconds.increase('PT1M') + # Total time of SELECT queries. + - name: instance_querytime_select_microseconds + exp: ClickHouseProfileEvents_SelectQueryTimeMicroseconds.increase('PT1M') + # Total time of INSERT queries. + - name: instance_querytime_insert_microseconds + exp: ClickHouseProfileEvents_InsertQueryTimeMicroseconds.increase('PT1M') + # Total time of queries that are not SELECT or INSERT. + - name: instance_querytime_other_microseconds + exp: ClickHouseProfileEvents_OtherQueryTimeMicroseconds.increase('PT1M') + # Number of reads from a file that were slow. + - name: instance_query_slow + exp: ClickHouseProfileEvents_SlowRead.rate('PT1M') + # Insertion + # Number of rows INSERTed to all tables. + - name: instance_inserted_rows + exp: ClickHouseProfileEvents_InsertedRows.rate('PT1M') + # Number of bytes INSERTed to all tables. + - name: instance_inserted_bytes + exp: ClickHouseProfileEvents_InsertedBytes.rate('PT1M') + # Number of times the INSERT of a block to a MergeTree table was throttled due to high number of active data parts for partition. + - name: instance_delayed_inserts + exp: ClickHouseProfileEvents_DelayedInserts.rate('PT1M') + # Replicas + # Number of data parts checking for consistency. + - name: instance_replicated_checks + exp: ClickHouseMetrics_ReplicatedChecks + # Number of data parts being fetched from replica. + - name: instance_replicated_fetch + exp: ClickHouseMetrics_ReplicatedFetch + # Number of data parts being sent to replicas. + - name: instance_replicated_send + exp: ClickHouseMetrics_ReplicatedSend + # MergeTree + # Number of executing background merges. + - name: instance_background_merge + exp: ClickHouseMetrics_Merge + # Rows read for background merges. This is the number of rows before merge. + - name: instance_merge_rows + exp: ClickHouseProfileEvents_MergedRows.increase('PT1M') + # Uncompressed bytes (for columns as they stored in memory) that was read for background merges. This is the number before merge. + - name : instance_merge_uncompressed_bytes + exp: ClickHouseProfileEvents_MergedUncompressedBytes.increase('PT1M') + # Number of currently executing moves. + - name: instance_move + exp: ClickHouseMetrics_Move + # Active data part, used by current and upcoming SELECTs. + - name: instance_parts_active + exp: ClickHouseMetrics_PartsActive + # Number of mutations (ALTER DELETE/UPDATE). + - name: instance_mutations + exp: ClickHouseMetrics_PartMutation + # Kafka Table Engine + # Number of Kafka messages already processed by ClickHouse. + - name: instance_kafka_messages_read + exp: ClickHouseProfileEvents_KafkaMessagesRead.rate('PT1M') + # Number of writes (inserts) to Kafka tables. + - name: instance_kafka_writes + exp: ClickHouseProfileEvents_KafkaWrites.rate('PT1M') + # Number of active Kafka consumers. + - name: instance_kafka_consumers + exp: ClickHouseMetrics_KafkaConsumers + # Number of active Kafka producer created. + - name: instance_kafka_producers + exp: ClickHouseMetrics_KafkaProducers + # Zookeeper + # Number of sessions (connections) to ZooKeeper. Should be no more than one, because using more than one connection to ZooKeeper may lead to bugs due to lack of linearizability (stale reads) that ZooKeeper consistency model allows. + - name: instance_zookeeper_session + exp: ClickHouseMetrics_ZooKeeperSession + # Number of watches (event subscriptions) in ZooKeeper. + - name: instance_zookeeper_watch + exp: ClickHouseMetrics_ZooKeeperWatch + # Number of bytes send over network while communicating with ZooKeeper. + - name: instance_zookeeper_bytes_sent + exp: ClickHouseProfileEvents_ZooKeeperBytesSent.rate('PT1M') + # Number of bytes received over network while communicating with ZooKeeper. + - name: instance_zookeeper_bytes_received + exp: ClickHouseProfileEvents_ZooKeeperBytesReceived.rate('PT1M') + # ClickHouse Keeper + # Number of alive connections for embedded ClickHouse Keeper. + - name: instance_keeper_connections_alive + exp: ClickHouseMetrics_KeeperAliveConnections + # Number of outstanding requests for embedded ClickHouse Keeper. + - name: instance_keeper_outstanding_requests + exp: ClickHouseMetrics_KeeperOutstandingRequets + diff --git a/oap-server/server-starter/src/main/resources/otel-rules/clickhouse/clickhouse-service.yaml b/oap-server/server-starter/src/main/resources/otel-rules/clickhouse/clickhouse-service.yaml new file mode 100644 index 0000000000..940d891f64 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/otel-rules/clickhouse/clickhouse-service.yaml @@ -0,0 +1,162 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This will parse a textual representation of a duration. The formats +# accepted are based on the ISO-8601 duration format {@code PnDTnHnMn.nS} +# with days considered to be exactly 24 hours. +#
+# Examples: +#
+# "PT20.345S" -- parses as "20.345 seconds" +# "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) +# "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) +# "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds) +# "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes" +# "P-6H3M" -- parses as "-6 hours and +3 minutes" +# "-P6H3M" -- parses as "-6 hours and -3 minutes" +# "-P-6H+3M" -- parses as "+6 hours and -3 minutes" +#+filter: "{ tags -> tags.job_name == 'clickhouse-monitoring' }" # The OpenTelemetry job name +expSuffix: tag({tags -> tags.host_name = 'clickhouse::' + tags.host_name}).service(['host_name'] , Layer.CLICKHOUSE) +metricPrefix: meter_clickhouse +metricsRules: + # Number of files opened per minute. + - name: file_open + exp: ClickHouseProfileEvents_FileOpen.sum(['host_name','service_instance_id']).increase('PT1M') + # Network + # Number of connections to TCP server. + - name: tcp_connections + exp: ClickHouseMetrics_TCPConnection.sum(['host_name','service_instance_id']) + # Number of client connections using MySQL protocol. + - name: mysql_connections + exp: ClickHouseMetrics_MySQLConnection.sum(['host_name','service_instance_id']) + # Number of connections to HTTP server. + - name: http_connections + exp: ClickHouseMetrics_HTTPConnection.sum(['host_name','service_instance_id']) + # Number of connections from other replicas to fetch parts. + - name: interserver_connections + exp: ClickHouseMetrics_InterserverConnection.sum(['host_name','service_instance_id']) + # Number of client connections using PostgreSQL protocol. + - name: postgresql_connections + exp: ClickHouseMetrics_PostgreSQLConnection.sum(['host_name','service_instance_id']) + # Total number of bytes received from network. + - name: network_receive_bytes + exp: ClickHouseProfileEvents_NetworkReceiveBytes.sum(['host_name','service_instance_id']).increase('PT1M') + # Total number of bytes send to network. + - name: network_send_bytes + exp: ClickHouseProfileEvents_NetworkSendBytes.sum(['host_name','service_instance_id']).increase('PT1M') + # Query + # Number of executing queries. + - name: query + exp: ClickHouseProfileEvents_Query.sum(['host_name','service_instance_id']).increase('PT1M') + # Number of executing queries, but only for SELECT queries. + - name: query_select + exp: ClickHouseProfileEvents_SelectQuery.sum(['host_name','service_instance_id']).increase('PT1M') + # Number of executing queries, but only for INSERT queries. + - name: query_insert + exp: ClickHouseProfileEvents_InsertQuery.sum(['host_name','service_instance_id']).increase('PT1M') + # Number of SELECT queries per second. + - name: query_select_rate + exp: ClickHouseProfileEvents_SelectQuery.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of INSERT queries per second. + - name: query_insert_rate + exp: ClickHouseProfileEvents_InsertQuery.sum(['host_name','service_instance_id']).rate('PT1M') + # Total time of all queries + - name: querytime_microseconds + exp: ClickHouseProfileEvents_QueryTimeMicroseconds.sum(['host_name','service_instance_id']).increase('PT1M') + # Total time of SELECT queries. + - name: querytime_select_microseconds + exp: ClickHouseProfileEvents_SelectQueryTimeMicroseconds.sum(['host_name','service_instance_id']).increase('PT1M') + # Total time of INSERT queries. + - name: querytime_insert_microseconds + exp: ClickHouseProfileEvents_InsertQueryTimeMicroseconds.sum(['host_name','service_instance_id']).increase('PT1M') + # Total time of queries that are not SELECT or INSERT. + - name: querytime_other_microseconds + exp: ClickHouseProfileEvents_OtherQueryTimeMicroseconds.sum(['host_name','service_instance_id']).increase('PT1M') + # Number of reads from a file that were slow. + - name: query_slow + exp: ClickHouseProfileEvents_SlowRead.sum(['host_name','service_instance_id']).rate('PT1M') + # Insertion + # Number of rows INSERTed to all tables. + - name: inserted_rows + exp: ClickHouseProfileEvents_InsertedRows.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of bytes INSERTed to all tables. + - name: inserted_bytes + exp: ClickHouseProfileEvents_InsertedBytes.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of times the INSERT of a block to a MergeTree table was throttled due to high number of active data parts for partition. + - name: delayed_inserts + exp: ClickHouseProfileEvents_DelayedInserts.sum(['host_name','service_instance_id']).rate('PT1M') + # Replicas + # Number of data parts checking for consistency. + - name: replicated_checks + exp: ClickHouseMetrics_ReplicatedChecks.sum(['host_name','service_instance_id']) + # Number of data parts being fetched from replica. + - name: replicated_fetch + exp: ClickHouseMetrics_ReplicatedFetch.sum(['host_name','service_instance_id']) + # Number of data parts being sent to replicas. + - name: replicated_send + exp: ClickHouseMetrics_ReplicatedSend.sum(['host_name','service_instance_id']) + # MergeTree + # Number of executing background merges. + - name: background_merge + exp: ClickHouseMetrics_Merge.sum(['host_name','service_instance_id']) + # Rows read for background merges. This is the number of rows before merge. + - name: merge_rows + exp: ClickHouseProfileEvents_MergedRows.sum(['host_name','service_instance_id']).increase('PT1M') + # Uncompressed bytes (for columns as they stored in memory) that was read for background merges. This is the number before merge. + - name: merge_uncompressed_bytes + exp: ClickHouseProfileEvents_MergedUncompressedBytes.sum(['host_name','service_instance_id']).increase('PT1M') + # Number of currently executing moves. + - name: move + exp: ClickHouseMetrics_Move.sum(['host_name','service_instance_id']) + # Active data part, used by current and upcoming SELECTs. + - name: parts_active + exp: ClickHouseMetrics_PartsActive.sum(['host_name','service_instance_id']) + # Number of mutations (ALTER DELETE/UPDATE) + - name: mutations + exp: ClickHouseMetrics_PartMutation.sum(['host_name','service_instance_id']) + # Kafka Table Engine + # Number of Kafka messages already processed by ClickHouse. + - name: kafka_messages_read + exp: ClickHouseProfileEvents_KafkaMessagesRead.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of writes (inserts) to Kafka tables. + - name: kafka_writes + exp: ClickHouseProfileEvents_KafkaWrites.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of active Kafka consumers. + - name: kafka_consumers + exp: ClickHouseMetrics_KafkaConsumers.sum(['host_name','service_instance_id']) + # Number of active Kafka producer created. + - name: kafka_producers + exp: ClickHouseMetrics_KafkaProducers.sum(['host_name','service_instance_id']) + # Zookeeper + # Number of sessions (connections) to ZooKeeper. Should be no more than one, because using more than one connection to ZooKeeper may lead to bugs due to lack of linearizability (stale reads) that ZooKeeper consistency model allows + - name: zookeeper_session + exp: ClickHouseMetrics_ZooKeeperSession.sum(['host_name','service_instance_id']) + # Number of watches (event subscriptions) in ZooKeeper. + - name: zookeeper_watch + exp: ClickHouseMetrics_ZooKeeperWatch.sum(['host_name','service_instance_id']) + # Number of bytes send over network while communicating with ZooKeeper. + - name: zookeeper_bytes_sent + exp: ClickHouseProfileEvents_ZooKeeperBytesSent.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of bytes received over network while communicating with ZooKeeper. + - name: zookeeper_bytes_received + exp: ClickHouseProfileEvents_ZooKeeperBytesReceived.sum(['host_name','service_instance_id']).rate('PT1M') + # ClickHouse Keeper + # Number of alive connections for embedded ClickHouse Keeper. + - name: keeper_connections_alive + exp: ClickHouseMetrics_KeeperAliveConnections.sum(['host_name','service_instance_id']) + # Number of outstanding requests for embedded ClickHouse Keeper. + - name: keeper_outstanding_requests + exp: ClickHouseMetrics_KeeperOutstandingRequets.sum(['host_name','service_instance_id']) diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-instance.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-instance.json new file mode 100644 index 0000000000..dbc2ece018 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-instance.json @@ -0,0 +1,897 @@ +[{ + "id": "clickhouse-instance", + "configuration": { + "children": [ + { + "x": 0, + "y": 0, + "w": 6, + "h": 9, + "i": "0", + "type": "Widget", + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Instance Uptime(day)", + "name": "InstanceUptime", + "tips": "The server uptime in days" + }, + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_uptime)/3600/24" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "metricConfig": [ + { + "unit": "day", + "label": "Uptime(day)" + } + ], + "id": "0", + "moved": false + }, + { + "x": 6, + "y": 0, + "w": 6, + "h": 9, + "i": "1", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_file_open)" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Files Opened", + "name": "FilesOpened", + "tips": "Number of files opened in a minute" + }, + "metricConfig": [ + { + "label": "Files Opened", + "unit": "/min" + } + ], + "id": "1", + "moved": false + }, + { + "x": 12, + "y": 0, + "w": 6, + "h": 9, + "i": "2", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_cpu_usage/1000000" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "CPU usage(cores)", + "name": "CPU", + "tips": "CPU time spent seen by OS" + }, + "metricConfig": [ + { + "label": "CPU usage" + } + ], + "id": "2", + "moved": false + }, + { + "x": 18, + "y": 0, + "w": 6, + "h": 9, + "i": "3", + "type": "Widget", + "graph": { + "type": "Area", + "opacity": 0.4, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Memory(%)", + "name": "Memory", + "tips": "The percentage of memory (bytes) allocated/available by the server" + }, + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_memory_usage", + "meter_clickhouse_instance_memory_available" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "metricConfig": [ + { + "unit": "%", + "label": "Memory Usage(%)" + }, + { + "unit": "%", + "label": "Memory Available(%)" + } + ], + "id": "3", + "moved": false, + "metrics": [], + "metricTypes": [] + }, + { + "x": 0, + "y": 9, + "w": 6, + "h": 9, + "i": "4", + "type": "Widget", + "id": "4", + "metricTypes": [], + "metrics": [], + "metricMode": "Expression", + "moved": false, + "expressions": [ + "latest(meter_clickhouse_instance_version)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "name": "InstanceVersion", + "title": "Instance Version", + "tips": "The version of the ClickHouse instance(format in base-1000, 11022033 means version 11.22.33)." + } + }, + { + "x": 6, + "y": 9, + "w": 6, + "h": 9, + "i": "5", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_network_receive_bytes", + "meter_clickhouse_instance_network_send_bytes" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Network I/O(B)", + "name": "Network", + "tips": "Total number of bytes received from network or send to network" + }, + "metricConfig": [ + { + "unit": "Bytes", + "label": "Receive Bytes" + }, + { + "unit": "Bytes", + "label": "Send Bytes" + } + ], + "id": "5", + "moved": false + }, + { + "x": 12, + "y": 9, + "w": 12, + "h": 9, + "i": "6", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_tcp_connections", + "meter_clickhouse_instance_http_connections" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "HTTP/TCP Connections", + "name": "HTTPTCPConnections", + "tips": "Number of connections to HTTP/TCP server" + }, + "metricConfig": [ + { + "label": "TCP Connections" + }, + { + "label": "HTTP Connections" + } + ], + "id": "6", + "moved": false + }, + + { + "x": 0, + "y": 18, + "w": 6, + "h": 9, + "i": "7", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_query", + "meter_clickhouse_instance_query_select", + "meter_clickhouse_instance_query_insert" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Area", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Query", + "name": "Query", + "tips": "Number of executing queries" + }, + "metricConfig": [ + { + "label": "Query" + }, + { + "label": "Select Query" + }, + { + "label": "Insert Query" + } + ], + "id": "7", + "moved": false + }, + { + "x": 6, + "y": 18, + "w": 6, + "h": 9, + "i": "8", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_query_select_rate", + "meter_clickhouse_instance_query_insert_rate" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "QPS", + "name": "QPS", + "tips": "Queries per seconds" + }, + "metricConfig": [ + { + "label": "QPS(select)" + }, + { + "label": "QPS(insert)" + } + ], + "id": "8", + "moved": false + }, + { + "x": 12, + "y": 18, + "w": 6, + "h": 9, + "i": "9", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_querytime_microseconds/meter_clickhouse_instance_query/1000", + "meter_clickhouse_instance_querytime_select_microseconds/meter_clickhouse_instance_query_select/1000", + "meter_clickhouse_instance_querytime_insert_microseconds/meter_clickhouse_instance_query_insert/1000" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Area", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "QueryTime(ms)", + "name": "QueryTime", + "tips": "The avg query time of each query in milliseconds" + }, + "metricConfig": [ + { + "unit": "ms", + "label": "QueryTime(all)" + }, + { + "unit": "ms", + "label": "QueryTime(select)" + }, + { + "unit": "ms", + "label": "QueryTime(insert)" + } + ], + "id": "9", + "moved": false + }, + { + "x": 18, + "y": 18, + "w": 6, + "h": 9, + "i": "10", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_query_slow" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "File SlowRead", + "name": "FileSlowRead", + "tips": "Number of reads from a file that were slow" + }, + "metricConfig": [ + { + "label": "File SlowRead" + } + ], + "id": "10", + "moved": false + }, + { + "x": 0, + "y": 27, + "w": 12, + "h": 9, + "i": "11", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_background_merge" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Merge", + "name": "Merge", + "tips": "Number of executing background merges" + }, + "metricConfig": [ + { + "label": "Merge" + } + ], + "id": "11", + "moved": false + }, + { + "x": 12, + "y": 27, + "w": 12, + "h": 9, + "i": "12", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_mutations" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Mutations", + "name": "Mutations", + "tips": "Number of mutations (ALTER DELETE/UPDATE)" + }, + "metricConfig": [ + { + "label": "Mutations" + } + ], + "id": "12", + "moved": false + }, + { + "x": 0, + "y": 36, + "w": 8, + "h": 9, + "i": "13", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_inserted_bytes" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Inserted bytes(b/s)", + "name": "InsertedBytes", + "tips": "Number of bytes inserted to all tables per second" + }, + "metricConfig": [ + { + "label": "Inserted bytes" + } + ], + "id": "13", + "moved": false + }, + { + "x": 8, + "y": 36, + "w": 8, + "h": 9, + "i": "14", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_inserted_rows" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Inserted rows", + "name": "InsertedRows", + "tips": "Number of rows inserted to all tables per second" + }, + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "metricConfig": [ + { + "label": "Inserted rows(s)" + } + ], + "id": "14", + "moved": false + }, + { + "x": 16, + "y": 36, + "w": 8, + "h": 9, + "i": "15", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_delayed_inserts" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Delayed Inserts(s)", + "name": "DelayedInserts", + "tips": "Number of times the insert of a block to a MergeTree table was throttled due to high number of active data parts for partition" + }, + "metricConfig": [ + { + "label": "Delayed Inserts(s)" + } + ], + "id": "15", + "moved": false + }, + { + "x": 0, + "y": 45, + "w": 8, + "h": 9, + "i": "16", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_replicated_checks" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Data Parts Consistency", + "name": "DataPartsConsistency", + "tips": "Number of data parts checking for consistency" + }, + "metricConfig": [ + { + "label": "Data Parts Consistency" + } + ], + "id": "16", + "moved": false + }, + { + "x": 8, + "y": 45, + "w": 8, + "h": 9, + "i": "17", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_replicated_fetch", + "meter_clickhouse_instance_replicated_send" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "ReplicatedFetch & Send", + "name": "ReplicatedFetchSend", + "tips": "Number of data parts being fetched from replica, and number of data parts being sent to replicas" + }, + "metricConfig": [ + { + "label": "Replicated Fetch" + }, + { + "label": "Replicated Send" + } + ], + "id": "17", + "moved": false + }, + { + "x": 16, + "y": 45, + "w": 8, + "h": 9, + "i": "18", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_parts_active" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Data Parts Active", + "name": "DataPartsActive", + "tips": "Active data part, used by current and upcoming SELECTs" + }, + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "metricConfig": [ + { + "label": "Data Parts Active" + } + ], + "id": "18", + "moved": false + }, + { + "x": 0, + "y": 54, + "w": 3, + "h": 9, + "i": "19", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_zookeeper_session)" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Zookeeper Sessions", + "name": "ZookeeperSessions", + "tips": "Number of sessions (connections) to ZooKeeper" + }, + "metricConfig": [ + { + "label": "Zookeeper Sessions" + } + ], + "id": "19", + "moved": false + }, + { + "x": 3, + "y": 54, + "w": 3, + "h": 9, + "i": "20", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_zookeeper_watch)" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Zookeeper Watches", + "name": "ZookeeperWatches", + "tips": "Number of watches (event subscriptions) in ZooKeeper" + }, + "metricConfig": [ + { + "label": "Zookeeper Watches" + } + ], + "id": "20", + "moved": false + }, + { + "x": 6, + "y": 54, + "w": 6, + "h": 9, + "i": "21", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "meter_clickhouse_instance_zookeeper_bytes_sent", + "meter_clickhouse_instance_zookeeper_bytes_received" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Zookeeper Bytes Received & Send(b/s)", + "name": "ZookeeperBytesReceivedSend", + "tips": "Number of bytes received and send over network while communicating with ZooKeeper" + }, + "metricConfig": [ + { + "unit": "Bytes", + "label": "Sent Bytes" + }, + { + "unit": "Bytes", + "label": "Receive Bytes" + } + ], + "id": "21", + "moved": false + }, + { + "x": 12, + "y": 54, + "w": 6, + "h": 9, + "i": "22", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_keeper_connections_alive)" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Keeper Alive Connections", + "name": "KeeperAliveConnections", + "tips": "Number of alive connections for embedded ClickHouse Keeper" + }, + "metricConfig": [ + { + "label": "Keeper Alive Connections" + } + ], + "id": "22", + "moved": false + }, + { + "x": 18, + "y": 54, + "w": 6, + "h": 9, + "i": "23", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(meter_clickhouse_instance_keeper_outstanding_requests)" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "widget": { + "title": "Keeper Outstanding Requests", + "name": "KeeperOutstandingRequests", + "tips": "Number of outstanding requests for embedded ClickHouse Keeper" + }, + "metricConfig": [ + { + "label": "Keeper Outstanding Requests" + } + ], + "id": "23", + "moved": false + } + ], + "layer": "CLICKHOUSE", + "entity": "ServiceInstance", + "name": "ClickHouse-Instance", + "id": "clickhouse-instance", + "isRoot": false + } +}] diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-root.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-root.json new file mode 100644 index 0000000000..e3ce1e6528 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-root.json @@ -0,0 +1,47 @@ +[ + { + "id": "clickhouse-root", + "configuration": { + "children": [ + { + "x": 0, + "y": 3, + "w": 24, + "h": 43, + "i": "0", + "type": "Widget", + "graph": { + "type": "ServiceList", + "dashboardName": "ClickHouse-Service", + "fontSize": 12, + "showXAxis": false, + "showYAxis": false, + "showGroup": true + }, + "metricMode": "Expression" + }, + { + "x": 0, + "y": 0, + "w": 24, + "h": 3, + "i": "1", + "type": "Text", + "graph": { + "fontColor": "theme", + "backgroundColor": "theme", + "content": "Provide ClickHouse Server monitoring through OpenTelemetry's Prometheus Receiver", + "fontSize": 14, + "textAlign": "left", + "url": "https://skywalking.apache.org/docs/main/next/en/setup/backend/backend-clickhouse-monitoring/" + } + } + ], + "layer": "CLICKHOUSE", + "entity": "All", + "name": "ClickHouse-Root", + "id": "clickhouse-root", + "isRoot": true + } + } +] \ No newline at end of file diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-service.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-service.json new file mode 100644 index 0000000000..03b0f97436 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/clickhouse/clickhouse-service.json @@ -0,0 +1,806 @@ +[{ + "id": "clickhouse-service", + "configuration": { + "children": [ + { + "x": 0, + "y": 0, + "w": 24, + "h": 45, + "i": "0", + "type": "Tab", + "children": [ + { + "name": "Inspections", + "children": [ + { + "x": 0, + "y": 0, + "w": 8, + "h": 9, + "i": "1", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(aggregate_labels(meter_clickhouse_file_open,sum))" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "metricConfig": [ + { + "label": "File Open", + "unit": "/min" + } + ], + "widget": { + "title": "File Open", + "name": "FileOpen", + "tips": "Number of files opened in a minute" + }, + "id": "0-0-0", + "moved": false + }, + { + "x": 8, + "y": 0, + "w": 8, + "h": 9, + "i": "2", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_query,sum)", + "aggregate_labels(meter_clickhouse_query_select,sum)", + "aggregate_labels(meter_clickhouse_query_insert,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Area", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Query", + "name": "Query", + "tips": "Number of executing queries" + }, + "metricConfig": [ + { + "label": "Query" + }, + { + "label": "Select Query" + }, + { + "label": "Insert Query" + } + ], + "id": "0-0-1", + "moved": false + }, + { + "x": 16, + "y": 0, + "w": 8, + "h": 9, + "i": "3", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_querytime_microseconds,sum)/aggregate_labels(meter_clickhouse_query,sum)/1000", + "aggregate_labels(meter_clickhouse_querytime_select_microseconds,sum)/aggregate_labels(meter_clickhouse_query_select,sum)/1000", + "aggregate_labels(meter_clickhouse_querytime_insert_microseconds,sum)/aggregate_labels(meter_clickhouse_query_insert,sum)/1000" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Area", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "QueryTime(ms)", + "name": "QueryTime", + "tips": "The avg query time of each query in milliseconds" + }, + "metricConfig": [ + { + "unit": "ms", + "label": "QueryTime" + }, + { + "unit": "ms", + "label": "QueryTime(select)" + }, + { + "unit": "ms", + "label": "QueryTime(insert)" + } + ], + "id": "0-0-2", + "moved": false + }, + { + "x": 0, + "y": 9, + "w": 8, + "h": 9, + "i": "4", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_tcp_connections,sum)", + "aggregate_labels(meter_clickhouse_http_connections,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "HTTP/TCP Connections", + "name": "HTTPTCPConnections", + "tips": "Number of connections to HTTP/TCP server" + }, + "metricConfig": [ + { + "label": "TCP Connections" + }, + { + "label": "HTTP Connections" + } + ], + "id": "0-0-3", + "moved": false + }, + { + "x": 8, + "y": 9, + "w": 8, + "h": 9, + "i": "5", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_query_select_rate,sum)", + "aggregate_labels(meter_clickhouse_query_insert_rate,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "QPS", + "name": "QPS", + "tips": "Queries per seconds" + }, + "metricConfig": [ + { + "label": "QPS(select)" + }, + { + "label": "QPS(insert)" + } + ], + "id": "0-0-4", + "moved": false + }, + { + "x": 16, + "y": 9, + "w": 8, + "h": 9, + "i": "6", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_query_slow,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "File SlowRead", + "name": "FileSlowRead", + "tips": "Number of reads from a file that were slow" + }, + "metricConfig": [ + { + "label": "File SlowRead" + } + ], + "id": "0-0-5", + "moved": false + }, + { + "x": 0, + "y": 18, + "w": 12, + "h": 9, + "i": "7", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_background_merge,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Merge", + "name": "Merge", + "tips": "Number of executing background merges" + }, + "metricConfig": [ + { + "label": "Merge" + } + ], + "id": "0-0-6", + "moved": false + }, + { + "x": 12, + "y": 18, + "w": 12, + "h": 9, + "i": "8", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_mutations,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Mutations", + "name": "Mutations", + "tips": "Number of mutations (ALTER DELETE/UPDATE)" + }, + "metricConfig": [ + { + "label": "Mutations" + } + ], + "id": "0-0-7", + "moved": false + }, + { + "x": 0, + "y": 27, + "w": 6, + "h": 9, + "i": "9", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_query_insert,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Insert Query(s)", + "name": "InsertQuery", + "tips": "Insert queries executing per second" + }, + "metricConfig": [ + { + "label": "Insert Query(s)" + } + ], + "id": "0-0-8", + "moved": false + }, + { + "x": 6, + "y": 27, + "w": 6, + "h": 9, + "i": "10", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_inserted_bytes,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Inserted bytes(s)", + "name": "InsertedBytes", + "tips": "Number of bytes inserted to all tables per second" + }, + "metricConfig": [ + { + "label": "Inserted bytes(s)" + } + ], + "id": "0-0-9", + "moved": false + }, + { + "x": 12, + "y": 27, + "w": 6, + "h": 9, + "i": "11", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_inserted_rows,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Inserted rows(s)", + "name": "InsertedRows", + "tips": "Number of rows inserted to all tables per second" + }, + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "metricConfig": [ + { + "label": "Inserted rows(s)" + } + ], + "id": "0-0-10", + "moved": false + }, + { + "x": 18, + "y": 27, + "w": 6, + "h": 9, + "i": "12", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_delayed_inserts,sum)" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Delayed Inserts(s)", + "name": "DelayedInserts", + "tips": "Number of times the insert of a block to a MergeTree table was throttled due to high number of active data parts for partition" + }, + "metricConfig": [ + { + "label": "Delayed Inserts(s)" + } + ], + "id": "0-0-11", + "moved": false + }, + { + "x": 0, + "y": 36, + "w": 8, + "h": 9, + "i": "13", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_replicated_checks,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Data Parts Consistency", + "name": "DataPartsConsistency", + "tips": "Number of data parts checking for consistency" + }, + "metricConfig": [ + { + "label": "Data Parts Consistency" + } + ], + "id": "0-0-12", + "moved": false + }, + { + "x": 8, + "y": 36, + "w": 8, + "h": 9, + "i": "14", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_replicated_fetch,sum)", + "aggregate_labels(meter_clickhouse_replicated_send,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "ReplicatedFetch & Send", + "name": "ReplicatedFetchSend", + "tips": "Number of data parts being fetched from replica, and number of data parts being sent to replicas" + }, + "metricConfig": [ + { + "label": "Replicated Fetch" + }, + { + "label": "Replicated Send" + } + ], + "id": "0-0-13", + "moved": false + }, + { + "x": 16, + "y": 36, + "w": 8, + "h": 9, + "i": "15", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_parts_active,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES" + ], + "widget": { + "title": "Data Parts Active", + "name": "DataPartsActive", + "tips": "Active data part, used by current and upcoming SELECTs" + }, + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "metricConfig": [ + { + "label": "Data Parts Active" + } + ], + "id": "0-0-14", + "moved": false + }, + { + "x": 0, + "y": 45, + "w": 3, + "h": 9, + "i": "16", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(aggregate_labels(meter_clickhouse_zookeeper_session,sum))" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "metricConfig": [ + { + "label": "Zookeeper Sessions" + } + ], + "widget": { + "name": "ZookeeperSessions", + "title": "Zookeeper Sessions", + "tips": "Number of sessions (connections) to ZooKeeper" + }, + "id": "0-0-15", + "moved": false, + "metrics": [], + "metricTypes": [], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + } + }, + { + "x": 3, + "y": 45, + "w": 3, + "h": 9, + "i": "17", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(aggregate_labels(meter_clickhouse_zookeeper_watch,sum))" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "widget": { + "name": "ZookeeperWatches", + "title": "Zookeeper Watches", + "tips": "Number of watches (event subscriptions) in ZooKeeper" + }, + "id": "0-0-16", + "moved": false, + "metrics": [], + "metricTypes": [], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + } + }, + { + "x": 6, + "y": 45, + "w": 6, + "h": 9, + "i": "18", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "aggregate_labels(meter_clickhouse_zookeeper_bytes_sent,sum)", + "aggregate_labels(meter_clickhouse_zookeeper_bytes_received,sum)" + ], + "typesOfMQE": [ + "TIME_SERIES_VALUES", + "TIME_SERIES_VALUES" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "metricConfig": [ + { + "label": "Sent Bytes", + "unit": "Bytes" + }, + { + "unit": "Bytes", + "label": "Receive Bytes" + } + ], + "widget": { + "name": "ZookeeperBytesReceivedSend", + "title": "Zookeeper Bytes Received & Send(b/s)", + "tips": "Number of bytes received and send over network while communicating with ZooKeeper" + }, + "id": "0-0-17", + "moved": false, + "metrics": [], + "metricTypes": [] + }, + { + "x": 12, + "y": 45, + "w": 6, + "h": 9, + "i": "19", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(aggregate_labels(meter_clickhouse_keeper_connections_alive,sum))" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center" + }, + "widget": { + "title": "Keeper Alive Connections", + "name": "KeeperAliveConnections", + "tips": "Number of alive connections for embedded ClickHouse Keeper" + }, + "metricConfig": [ + { + "label": "Keeper Alive Connections" + } + ], + "id": "0-0-18", + "moved": false + }, + { + "x": 18, + "y": 45, + "w": 6, + "h": 9, + "i": "20", + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "latest(aggregate_labels(meter_clickhouse_keeper_outstanding_requests,sum))" + ], + "typesOfMQE": [ + "SINGLE_VALUE" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center" + }, + "widget": { + "title": "Keeper Outstanding Requests", + "name": "KeeperOutstandingRequests", + "tips": "Number of outstanding requests for embedded ClickHouse Keeper" + }, + "metricConfig": [ + { + "label": "Keeper Outstanding Requests" + } + ], + "id": "0-0-19", + "moved": false + } + ] + }, + { + "name": "Instances", + "children": [ + { + "x": 0, + "y": 0, + "w": 24, + "h": 17, + "type": "Widget", + "metricMode": "Expression", + "expressions": [ + "" + ], + "typesOfMQE": [ + "" + ], + "graph": { + "type": "InstanceList", + "dashboardName": "ClickHouse-Instance", + "fontSize": 12 + }, + "id": "0-1-1", + "moved": false + } + ] + } + ], + "id": "0", + "activedTabIndex": 0, + "moved": false + } + ], + "layer": "CLICKHOUSE", + "entity": "Service", + "name": "ClickHouse-Service", + "id": "clickhouse-service", + "isRoot": false, + "isDefault": true, + "expressions": [ + "aggregate_labels(meter_clickhouse_query_select_rate,sum)", + "aggregate_labels(meter_clickhouse_query_insert_rate,sum)" + ], + "expressionsConfig": [ + { + "unit": "rows / s", + "label": "Select" + }, + { + "unit": "rows / s", + "label": "Insert" + } + ] + } +}] diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/menu.yaml b/oap-server/server-starter/src/main/resources/ui-initialized-templates/menu.yaml index b94a062c8f..0fe0f48522 100644 --- a/oap-server/server-starter/src/main/resources/ui-initialized-templates/menu.yaml +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/menu.yaml @@ -188,6 +188,11 @@ menus: description: Provide BookKeeper monitoring through OpenTelemetry's Prometheus Receiver. documentLink: https://skywalking.apache.org/docs/main/next/en/setup/backend/backend-bookkeeper-monitoring/ i18nKey: database_bookkeeper + - title: ClickHouse + layer: CLICKHOUSE + description: Provide ClickHouse Server monitoring through OpenTelemetry's Prometheus Receiver. + documentLink: https://skywalking.apache.org/docs/main/next/en/setup/backend/backend-clickhouse-monitoring/ + i18nKey: database_clickhouse - title: Message Queue icon: mq description: A message queue is a form of asynchronous service-to-service communication used in serverless and microservices architectures. diff --git a/test/e2e-v2/cases/clickhouse/clickhouse-cases.yaml b/test/e2e-v2/cases/clickhouse/clickhouse-cases.yaml new file mode 100644 index 0000000000..d928d7ecec --- /dev/null +++ b/test/e2e-v2/cases/clickhouse/clickhouse-cases.yaml @@ -0,0 +1,200 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This file is used to show how to write configuration files and can be used to test. + +cases: + # service list + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql service ls + expected: expected/service.yml + # service metrics + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_tcp_connections --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_mysql_connections --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_http_connections --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_postgresql_connections --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_network_receive_bytes --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_network_send_bytes --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query_select --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query_insert --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query_select_rate --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query_insert_rate --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_querytime_microseconds --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_querytime_select_microseconds --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_querytime_insert_microseconds --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_querytime_other_microseconds --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_query_slow --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_inserted_rows --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_inserted_bytes --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_delayed_inserts --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_replicated_checks --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_replicated_fetch --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_background_merge --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_merge_rows --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_parts_active --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_mutations --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_kafka_messages_read --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_kafka_writes --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_kafka_consumers --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_kafka_producers --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_zookeeper_session --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_zookeeper_watch --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_zookeeper_bytes_sent --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_zookeeper_bytes_received --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_keeper_connections_alive --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_keeper_outstanding_requests --service-name=clickhouse::clickhouse:8123 + expected: expected/metrics-has-value-label.yml + + # instance metrics + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_version --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_cpu_usage --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_memory_usage --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_memory_available --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_uptime --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_file_open --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # Network + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_tcp_connections --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_mysql_connections --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_http_connections --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_interserver_connections --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_postgresql_connections --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_network_receive_bytes --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_network_send_bytes --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # Query + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query_select --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query_insert --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query_select_rate --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query_insert_rate --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_querytime_microseconds --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_querytime_select_microseconds --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_querytime_insert_microseconds --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_querytime_other_microseconds --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_query_slow --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # Insertion + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_inserted_rows --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_inserted_bytes --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_delayed_inserts --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + + # Replicas + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_replicated_checks --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_replicated_fetch --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_replicated_send --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # MergeTree + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_background_merge --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_merge_rows --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_merge_uncompressed_bytes --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_move --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_parts_active --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_mutations --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # Kafka Table Engine + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_kafka_messages_read --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_kafka_writes --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_kafka_consumers --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_kafka_producers --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # Zookeeper + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_zookeeper_session --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_zookeeper_watch --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_zookeeper_bytes_sent --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_zookeeper_bytes_received --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + + # ClickHouse Keeper + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_keeper_connections_alive --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_clickhouse_instance_keeper_outstanding_requests --service-name=clickhouse::clickhouse:8123 --instance-name=clickhouse1:9363 + expected: expected/metrics-has-value.yml diff --git a/test/e2e-v2/cases/clickhouse/clickhouse-prometheus-endpoint/clickhouse1/config.xml b/test/e2e-v2/cases/clickhouse/clickhouse-prometheus-endpoint/clickhouse1/config.xml new file mode 100644 index 0000000000..857f343e60 --- /dev/null +++ b/test/e2e-v2/cases/clickhouse/clickhouse-prometheus-endpoint/clickhouse1/config.xml @@ -0,0 +1,487 @@ + + +