Agent Check: ClickHouse

Overview

This check monitors ClickHouse through the Datadog Agent.

Minimum Agent version: 7.16.0

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The ClickHouse check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

Prepare ClickHouse

As a best practice, Datadog recommends using a read-only user to monitor your ClickHouse instance. This limits the access granted to the Datadog Agent.

Host

To configure this check for an Agent running on a host:

Metric collection

1. To start collecting your ClickHouse performance data, edit the clickhouse.d/conf.yaml file in the conf.d/ folder at the root of your Agent's configuration directory. See the sample clickhouse.d/conf.yaml for all available configuration options.

Note: This integration uses the official clickhouse-connect client to connect over HTTP.

2. Restart the Agent.

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

   logs_enabled: true

2. Add the log files you are interested in to your clickhouse.d/conf.yaml file to start collecting your ClickHouse logs:

     logs:
       - type: file
         path: /var/log/clickhouse-server/clickhouse-server.log
         source: clickhouse
         service: "<SERVICE_NAME>"

   Change the path and service parameter values and configure them for your environment. See the sample clickhouse.d/conf.yaml for all available configuration options.

3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection

Parameter	Value
<INTEGRATION_NAME>	clickhouse
<INIT_CONFIG>	blank or {}
<INSTANCE_CONFIG>	{"server": "%%host%%", "port": "%%port%%", "username": "<USER>", "password": "<PASSWORD>"}

Log collection

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection.

Parameter	Value
<LOG_CONFIG>	{"source": "clickhouse", "service": "<SERVICE_NAME>"}

Validation

Run the Agent's status subcommand and look for clickhouse under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The ClickHouse check does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.