ClickHouse

Prometheus Metrics

ClickHouse is a high-performance, column-oriented SQL database for real-time analytics.

Prometheus Metrics

Service Configuration

ClickHouse exposes Prometheus metrics since version 20.1.2.4. Add a <prometheus> section to your configuration by editing config.xml or creating a drop-in file at /etc/clickhouse-server/config.d/prometheus.xml:

<clickhouse>
    <prometheus>
        <endpoint>/metrics</endpoint>
        <port>9363</port>
        <metrics>true</metrics>
        <events>true</events>
        <asynchronous_metrics>true</asynchronous_metrics>
    </prometheus>
</clickhouse>

Restart ClickHouse for the change to take effect. Metrics are then available at http://localhost:9363/metrics.

Glouton Configuration

Linux

sudo tee /etc/glouton/conf.d/99-clickhouse.conf > /dev/null << 'EOF'
metric:
  prometheus:
    targets:
      - url: "http://localhost:9363/metrics"
        name: "clickhouse"
        allow_metrics:
          - "ClickHouseProfileEvents_Query"
          - "ClickHouseMetrics_Query"
          - "ClickHouseAsyncMetrics_*"
          - "ClickHouseProfileEvents_InsertedRows"
          - "ClickHouseMetrics_MemoryTracking"
EOF

Windows

Create or edit C:\ProgramData\glouton\conf.d\99-clickhouse.conf:

metric:
  prometheus:
    targets:
      - url: "http://localhost:9363/metrics"
        name: "clickhouse"
        allow_metrics:
          - "ClickHouseProfileEvents_Query"
          - "ClickHouseMetrics_Query"
          - "ClickHouseAsyncMetrics_*"
          - "ClickHouseProfileEvents_InsertedRows"
          - "ClickHouseMetrics_MemoryTracking"

Glouton automatically detects configuration changes.

Customize collected metrics

The metrics below are our recommended defaults. You can adjust the allow_metrics list to include any metric from ClickHouse’s monitoring documentation, or use deny_metrics to exclude specific ones. See Metrics Filtering for details.

Metric	Description
ClickHouseProfileEvents_Query	Total number of queries executed by ClickHouse
ClickHouseMetrics_Query	Number of queries currently being executed
ClickHouseAsyncMetrics_*	Asynchronous metrics including system-level resource usage
ClickHouseProfileEvents_InsertedRows	Total number of rows inserted into tables
ClickHouseMetrics_MemoryTracking	Amount of memory currently allocated by the server in bytes