Configure Pulse to Monitor ClickHouse

This page describes how to configure Pulse to monitor ClickHouse performance and enable query-level observability.

You’ll:

• Configure Pulse to listen on Prometheus port (default 9363) using the accelo config cluster command.
• Deploy the ad-clickhouse-connector add-on to process and display ClickHouse metrics in Pulse.

Before You Begin

Before setting up Pulse to monitor ClickHouse, make sure your Hadoop cluster is already configured to send ClickHouse metrics to Pulse. For detailed steps, see Configure ODP ClickHouse.

Enter ClickHouse Ports

Docker-Based Pulse Deployment

If you have deployed Pulse with Docker, follow the steps below to enter the ports.

1. On a Pulse node, run the following command.

accelo config cluster

2. When prompted in the CLI, enter the cluster details such as cluster name, Hadoop distribution, etc., and the Prometheus ports for ClickHouse services (Server and Keeper).

Enter the ClickHouse Server Prometheus metrics port (default 9363): 9363

​

Enter the ClickHouse Keeper Prometheus metrics port (default 9363): 9363

Kubernetes-Based Pulse Deployment

If you have deployed Pulse on Kubernetes, follow the steps below to configure the ClickHouse Server and Keeper ports (default: 9363).

• During cluster setup: If you are configuring ClickHouse while setting up the cluster in Pulse, enter the ports in the list of options under Cluster Configuration. For detailed instructions, see Configure Cluster Details.
• After cluster configuration: If you are configuring ClickHouse after completing the cluster setup in Pulse, see (Link Removed).

Deploy the Clickhouse Connector Add-On

Deploy the ad-clickhouse-connector add-on service to continuously poll job-related data from ClickHouse.

The connector retrieves key metrics such as query start time, end time, and execution statistics (for example, job duration and resource utilization), etc., which Pulse uses to display detailed job-level insights in the UI.

Docker-Based Pulse Deployment

If you have deployed Pulse with Docker, follow the steps below to deploy the add-on service.

1. On a Pulse node, run the following command.

accelo deploy addons

The list of available Pulse add-on services appears on screen.

2. Select the ClickHouse Connector along with other components or services you want to deploy.

? Select the components you would like to install:  

  [x] ClickHouse Connector

  [ ] Actions Service  

  [x] Alerts (Agents MUST be configured)  

  [ ] CONFIG SERVER DB  

  [x] Core Connectors  

  [x] Dashplot  

  [ ] Director (Agents MUST be configured)  

​

  [Use arrows to move, space to select, <right> to all, <left> to none, type to filter]

Kubernetes-Based Pulse Deployment

If you have deployed Pulse on Kubernetes, see Deploy Pulse Add-on Services to deploy the ClickHouse Connector add-on service.