Enable Bundled Prometheus Exporter for ClickHouse DB
Overview
ClickHouse provides a built-in Prometheus exporter that allows monitoring tools like Prometheus to scrape internal metrics directly from the database. This eliminates the need for any external exporter in modern setups. In the default ClickHouse configuration, the Prometheus exporter settings are already available but kept commented out. Enabling the exporter requires uncommenting and activating this configuration.
Supported Versions
The bundled Prometheus exporter is available starting from ClickHouse 19.x and above. For older versions, an external exporter such as clickhouse_exporter must be used.
Step 1: Open ClickHouse Configuration
Go to the main config file:
sudo vi /etc/clickhouse-server/config.xml
Step 2: Locate Commented Prometheus Section
Search for prometheus inside the file. You will typically find a commented block like this:
<prometheus>
<endpoint>/metrics</endpoint>
<port>9363</port>
<metrics>true</metrics>
<events>true</events>
<asynchronous_metrics>true</asynchronous_metrics>
</prometheus>
-->
Step 3: Uncomment the Prometheus Block
Remove the comment tags <!-- --> so it becomes:
<endpoint>/metrics</endpoint>
<port>9363</port>
<metrics>true</metrics>
<events>true</events>
<asynchronous_metrics>true</asynchronous_metrics>
</prometheus>
Note: f the port number or endpoint needs to be modified, update the configuration as required. The default values are suitable for most setups.
Step 4: Restart ClickHouse Service
Step 5: Verify Prometheus Endpoint
You should see metrics output in Prometheus format.
Step 6: Configure Prometheus Scrape Job
Update prometheus.yml:
scrape_configs:
- job_name: 'clickhouse'
static_configs:
- targets: ['<clickhouse-host>:9363']
Step 7: Reload Prometheus
Step 8: Validate in Prometheus UI
- Open:
http://<prometheus-host>:9090 - Check Targets
- Ensure status is UP
New to ADSelfService Plus?
Related Articles
APM Insight Python Agent & Data Exporter Onboarding Docker Guide (Same Container)
Overview This guide explains how to enable APM Insight monitoring for your Python application running in Docker, using the APM Insight Python agent and Data Exporter (In Same Container). 1. Download the Required Components APM Insight Python Agent: ...How to configure Tomcat Exporter to scrape metrics from Prometheus?
To setup exporter, follow the steps given below: Install a standalone Tomcat-sever or as a container as kubernetes cluster. Download the Tomcat exporter servlet file in .war format from here. Rename the file as metrics.war and deploy it in the ...JDBC data not populated for tomcat added by Prometheus
To configure JDBC metrics in tomcat exporter 1) Open the below file from tomcat installation directory. $CATALINA_BASE/conf/server.xml 2) Add the following configuration under <GlobalNamingResources> tag in the server.xml file. <Resource ...Integrating Applications Manager DB with Grafana
Grafana is an open-source data visualization tool that collects data across multiple software platforms and retrieves them altogether in a single dashboard. It provides advanced analytics by connecting to various data sources in different platforms, ...How to configure Prometheus inside Openshift to scrape necessary metrics for Applications Manager?
To setup Prometheus inside a Openshift Cluster and scrape metrics for monitoring the same in Applications Manager, kindly follow the steps given below: Create a new Project "monitor" inside the Desired Cluster to be monitored using the below command. ...