Clickhouse

Introduction

ClickHouse is an open-source database management system (DBMS) that’s used for online analytical processing (OLAP). It’s designed to process large amounts of data quickly and efficiently.

Usally it exposes Prometheus metrics on https://:8001/metrics

Kubernetes 2.0 ConfigMap

Users should update or append the existing ConfigMap named opsramp-workload-metric-user-config by adding application-specific fields. These fields may include authentication credentials, collection frequency, and other relevant configurations.

apiVersion: v1
kind: ConfigMap
metadata:
  name: opsramp-workload-metric-user-config
  namespace: opsramp-agent
data:
  workloads: |
    clickhouse:
    - name: clickhouse
      collectionFrequency: 59s
      port: 8001
      filters:
        - regex: 'ClickHouseProfileEvents_KeeperCommits'
          action: include
        - regex: 'ClickHouseAsyncMetrics_VMMaxMapCount' 
          action: include
      targetPodSelector:
        matchLabels:
          - key: app.kubernetes.io/name
            operator: ==
            value:
              - clickhouse

Supported Metrics

Supported metrics for this workload as provided by the Kubernetes 2.0 Agent.

Metric	Description
ClickHouseProfileEvents_Query	Total number of queries executed in ClickHouse.
ClickHouseProfileEvents_SelectQuery	Total number of SELECT queries executed.
ClickHouseProfileEvents_InsertQuery	Total number of INSERT queries executed.
ClickHouseProfileEvents_InitialQuery	Tracks the number of initial queries executed (root queries).
ClickHouseProfileEvents_QueriesWithSubqueries	Number of queries that contain subqueries.
ClickHouseProfileEvents_SelectQueriesWithSubqueries	Number of SELECT queries that contain subqueries.
ClickHouseProfileEvents_InsertQueriesWithSubqueries	Number of INSERT queries that contain subqueries.
ClickHouseProfileEvents_SelectQueriesWithPrimaryKeyUsage	Number of SELECT queries utilizing a primary key for filtering.
ClickHouseProfileEvents_AsyncInsertQuery	Number of asynchronous INSERT queries executed.
ClickHouseProfileEvents_AsyncInsertBytes	Total bytes processed by asynchronous INSERT queries.
ClickHouseProfileEvents_AsyncInsertRows	Total rows inserted asynchronously.
ClickHouseProfileEvents_AsyncInsertCacheHits	Number of cache hits for asynchronous INSERT queries.
ClickHouseProfileEvents_FailedQuery	Number of queries that failed execution.
ClickHouseProfileEvents_FailedSelectQuery	Number of SELECT queries that failed execution.
ClickHouseProfileEvents_FailedInsertQuery	Number of INSERT queries that failed execution.
ClickHouseProfileEvents_FailedAsyncInsertQuery	Number of failed asynchronous INSERT queries.
ClickHouseProfileEvents_QueryTimeMicroseconds	Total execution time of queries in microseconds.
ClickHouseProfileEvents_SelectQueryTimeMicroseconds	Total execution time of SELECT queries in microseconds.
ClickHouseProfileEvents_InsertQueryTimeMicroseconds	Total execution time of INSERT queries in microseconds.
ClickHouseProfileEvents_OtherQueryTimeMicroseconds	Total execution time of non-SELECT, non-INSERT queries in microseconds.
ClickHouseMetrics_Query	Current number of executing queries.
ClickHouseMetrics_Merge	Current number of active merge operations.
ClickHouseMetrics_Move	Current number of part move operations.
ClickHouseMetrics_PartMutation	Number of active part mutations.
ClickHouseMetrics_ReplicatedFetch	Number of fetch operations from replicated tables.
ClickHouseMetrics_ReplicatedSend	Number of data replication send operations.
ClickHouseMetrics_ReplicatedChecks	Number of consistency checks on replicated data.
ClickHouseMetrics_BackgroundMergesAndMutationsPoolTask	Number of background merge and mutation tasks.
ClickHouseMetrics_BackgroundMergesAndMutationsPoolSize	Size of the background merge and mutation pool.
ClickHouseMetrics_BackgroundFetchesPoolTask	Number of background fetch tasks.
ClickHouseMetrics_BackgroundFetchesPoolSize	Size of the background fetch pool.
ClickHouseMetrics_CacheDictionaryUpdateQueueBatches	Number of batched updates in the cache dictionary update queue.
ClickHouseMetrics_CacheDictionaryUpdateQueueKeys	Number of keys waiting for update in the cache dictionary.
ClickHouseMetrics_DiskSpaceReservedForMerge	Amount of disk space reserved for ongoing merges.
ClickHouseMetrics_QueryPreempted	Number of queries that were preempted due to resource limits.
ClickHouseMetrics_TCPConnection	Current number of active TCP connections.
ClickHouseMetrics_MySQLConnection	Number of active MySQL connections.
ClickHouseMetrics_HTTPConnection	Number of active HTTP connections.
ClickHouseMetrics_InterserverConnection	Number of active inter-server connections.
ClickHouseMetrics_PostgreSQLConnection	Number of active PostgreSQL connections.
ClickHouseMetrics_OpenFileForRead	Number of files currently open for reading.
ClickHouseMetrics_OpenFileForWrite	Number of files currently open for writing.
ClickHouseMetrics_Compressing	Number of active compression operations.
ClickHouseMetrics_Decompressing	Number of active decompression operations.
ClickHouseMetrics_TemporaryFilesForSort	Number of temporary files used for sorting operations.
ClickHouseMetrics_TemporaryFilesForAggregation	Number of temporary files used for aggregations.
ClickHouseMetrics_Read	Current number of read operations.
ClickHouseMetrics_Write	Current number of write operations.
ClickHouseMetrics_KafkaConsumers	Number of active Kafka consumers.
ClickHouseMetrics_KafkaProducers	Number of active Kafka producers.
ClickHouseAsyncMetrics_OSGuestTime	Total CPU time spent in guest mode.
ClickHouseAsyncMetrics_BlockWriteTime_nbd5	Total time spent writing blocks to the nbd5 device.
ClickHouseAsyncMetrics_NetworkReceiveErrors_eth0	Number of network receive errors on eth0 interface.
ClickHouseAsyncMetrics_BlockReadTime_nbd2	Total time spent reading blocks from the nbd2 device.
ClickHouseAsyncMetrics_BlockWriteBytes_vda	Total bytes written to the vda block device.