The OpenTelemetry Collector, when configured with a Prometheus receiver, provides an integration with ClickHouse to scrape Prometheus metrics. The Collector uses the Prometheus Receiver to fetch metrics from the configured path in the ClickHouse configuration file. From there, the metrics are processed and exported to Lightstep Observability.

To complete the integration you will:

  • Configure ClickHouse to use the Prometheus exporter.
  • Configure the Collector to use the ClickHouse endpoint as a scrape target for the Prometheus receiver.
  • Enable the integration by adding it to a pipeline.

Prerequisites

  • ClickHouse v22.7 or later
  • You’ve configured the Collector to export metric data to Lightstep Observability.

Configure ClickHouse reporting

You need to configure ClickHouse to use the Prometheus exporter.

In the ClickHouse server config.xml configuration file, add the following:

1
2
3
4
5
6
7
<prometheus>
    <endpoint>/metrics</endpoint>
    <port>8001</port>
    <metrics>true</metrics>
    <events>true</events>
    <asynchronous_metrics>true</asynchronous_metrics>
</prometheus>

For more details about using ClickHouse with the Prometheus exporter, see the official ClickHouse documentation.

Configure the Collector receiver

In the Collector configuration file, configure the Prometheus receiver to use the ClickHouse Prometheus endpoint as a scrape target.

1
2
3
4
5
6
7
8
9
10
receivers:
  prometheus:
    config:
      scrape_configs:
        - job_name: 'clickhouse-server'
          metrics_path: '/v1/agent/metrics'
          params:
            format: ['prometheus']
          static_configs:
            - targets: ['${CLICKHOUSE_SERVER_HOST}']

The OpenTelemetry repo’s README provides additional details about Prometheus receiver configuration.

Enable the Collector receiver

Once the ClickHouse receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.

Validate metrics are reporting to Lightstep

You can validate that the metrics are reporting to Lightstep from the Metric details section of the Project Settings page.

  1. Open the Project settings page and scroll to the Metric details section.

  2. Search for ClickHouse metric names. Search for metric

    See the metric_log, asynchronous_metrics, and metrics Clickhouse documentation for a complete list of emitted metrics.

  3. If needed, click on the metric to edit the description and how the units are displayed in Lightstep.

Create a dashboard for the metrics

Use the Lightstep Terraform Provider to create a dashboard for the metrics.

Additional resources

For a more complete example that’s ready to run, see the ClickHouse integration in Lightstep OpenTelemetry Examples.