What's NewCloudZero Academy
Guides
CloudZero Status

Connecting to ClickHouse

How the ClickHouse Connection works

The ClickHouse connection uses a ClickHouse Cloud API key to ingest daily, organization-level cost data along with service and ClickPipes metadata. In CloudZero, you can view, track, and forecast your ClickHouse costs, broken down by service, data warehouse, ClickPipe, region, cloud provider, and cost metric (compute, storage, backup, data transfer, and more).

ℹ️

Costs are reported in ClickHouse Credits (CHC), where 1 CHC = 1 USD.

Supported ClickHouse Plans

This connection works with ClickHouse Cloud, ClickHouse's managed offering. Both the Admin and Developer API key roles are supported; the Developer role is sufficient.

Prerequisites for the ClickHouse Connection

Before you can connect CloudZero to ClickHouse, you must have the following:

  1. A ClickHouse Cloud Organization ID.
  2. A ClickHouse Cloud API key (Key ID and Key Secret) with at least the Developer role.

To connect CloudZero to ClickHouse, complete the following steps:

  1. Copy your Organization ID.
  2. Create an API Key in ClickHouse.
  3. Create the ClickHouse connection in CloudZero.

Step 1: Copy your Organization ID

  1. Sign in to ClickHouse Cloud.
  2. In the bottom-left of the console, open your Organization and select Organization Details.
  3. Copy the Organization ID (a UUID) and save it for later.

Step 2: Create an API Key in ClickHouse

  1. In the ClickHouse Cloud console, open the API Keys tab from the left menu.
  2. Select New API Key.
  3. Provide a descriptive name (for example, CloudZero Integration), assign a role, and set an expiration.
    • Developer — read-only access; sufficient for this connection.
    • Admin — full read and write access.
  4. Select Generate API Key.
  5. Copy the Key ID and Key Secret immediately and store them securely. ClickHouse displays the Key Secret only once.

For full details, see the ClickHouse OpenAPI documentation.

Step 3: Create the ClickHouse Connection in CloudZero

  1. In CloudZero, navigate to Cloud Integrations and select Add Connection.
  2. Select the ClickHouse tile and select Get Started.
  3. Enter a connection name.
  4. Enter your Organization ID.
  5. Enter your Key ID and Key Secret.
  6. Select Connect.

After CloudZero processes the first ingest of billing and usage data, the connection Status changes from Pending Data to Healthy.

Updated 2 days ago