Vantage connects to your ClickHouse Cloud account via a read-only API key with Developer permissions to ingest ClickHouse usage, costs, and discounts from ClickHouse’s Organization usageCost API. Vantage displays ClickHouse Cloud costs and associated usage metrics.
The Clickhouse Organizations usageCost API only supports ClickHouse Cloud and Bring Your Own Cloud (BYOC).
You can view usage data for ClickHouse Cloud consumption. Usage is measured by the following subcategories: Usage is measured in ClickHouse Cloud Credits (CHCs), which is a metering unit used by ClickHouse.
You can learn more about CHCs through ClickHouse Billing documentation.
You can integrate multiple ClickHouse Cloud integrations by providing read-only tokens for multiple organizations.

​
Connect Your ClickHouse Cloud Account

​
Prerequisites

Create a free Vantage account, then follow the steps below to integrate ClickHouse Cloud costs.
Vantage cannot perform writes to your ClickHouse Cloud organization. Vantage is only able to see metadata associated with your usage.

​
Create the Connection

The below instructions for creating an API key are based on the ClickHouse documentation.
1

In the ClickHouse Cloud console, navigate to the Settings menu. Then, select API keys.
2

Click + New API key.
3

Add the following key details:
  • For API key name, enter vantage.
  • For Expiration date, select an expiration date. If the key expires, you will need to supply Vantage with a new ClickHouse Cloud API key.
  • For Organization role, select Developer. (You can read more about roles and permissions in the ClickHouse documentation.)
  • For Service roles:
    • Under Access scope, select All services.
    • For Role, select Query Endpoints.
  • For Allow access to this API key from, select Anywhere.
4

Click Generate API Key.
If you have any IP restrictions set, ensure you allow the following IP addresses for Vantage:
  • 54.87.66.45
  • 3.95.43.133
  • 54.162.3.72
  • 44.199.143.63
  • 3.218.103.23
5

Copy the newly generated Key ID and Key Secret.
6

From the top navigation in Vantage, click Settings.
7

On the left navigation, select Integrations and select ClickHouse Cloud.
8

The ClickHouse Cloud integrations page is displayed. Ensure you are on the Connect tab.
9

At the bottom of the page, click Add API Key and paste your newly generated API key and secret.
10

For Organization ID, add the ClickHouse Cloud Organization ID that was assigned to your organization during creation. To find this ID:
  • From the Settings navigation menu, under Organization, select your organization and click Organization details.
  • Copy the value displayed next to Organization ID and paste this in the Vantage integration form.
11

Click Connect Account.
Costs will be ingested and processed as soon as you add the integration. It usually takes less than 15 minutes to ingest ClickHouse Cloud costs. As soon as they are processed, they will be available on your All Resources Cost Report. If you decide to remove your ClickHouse Cloud integration from Vantage, all costs associated with your ClickHouse Cloud API key will be removed from the Vantage console.

​
Next Steps - Manage Workspace Access

Once your costs are imported, select which workspaces this integration is associated with. See the Workspaces documentation for information.

​
Data Refresh

See the provider data refresh documentation for information on when data for each provider refreshes in Vantage.

​
Active Resources

ClickHouse Cloud services are synced as active resources and available in resource reports.

​
ClickHouse Cloud Reporting Dimensions

On ClickHouse Cloud Cost Reports, you can filter across several dimensions:
  • Organization (i.e., billing account)
  • Service (e.g., ClickHouse Cloud)
  • Category (e.g., datawarehouse or service)
  • Subcategory (e.g., specific usage category, like interRegionTier1DataTransferCHC or publicDataTransferCHC)
  • Resource (specific ID for a given ClickHouse cluster)
  • Tags: Includes Virtual Tags created in Vantage, as well as entityName, which is represented as Tag Key: clickhouse:entityName.
  • Charge Type (e.g., usage)
You can also view credits or discounts for ClickHouse Cloud costs in Cost Reports.
  1. At the top of any ClickHouse Cloud Cost Report, click Settings.
  2. Then, toggle on/off Credits and/or Discounts.