Agent Check: ClickHouse

Overview

This check monitors ClickHouse through the Datadog Agent.

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

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.

2. Restart the Agent.

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.

Service Checks

clickhouse.can_connect:
Returns CRITICAL if the Agent is unable to connect to the monitored ClickHouse database. Otherwise, returns OK.

Events

The ClickHouse check does not include any events.

Troubleshooting

Need help? Contact Datadog support.