Skip to main content

Confluent

Vantage integrates with your Confluent account using a Confluent API key and secret to access the Billing API. This endpoint provides structured cost data, broken down by category (e.g., Kafka or Connect), resource (e.g., Kafka Cluster), and subcategory (e.g., Kafka Storage or Connect Capacity).

Vantage currently supports the following Confluent products:

  • Kafka
  • Connect
  • KSQL
  • Audit Logs
  • Cluster Links
  • Custom Connect
  • Support Cloud

Connect Your Confluent Account​

Prerequisites​

Create a free Vantage account, then follow the steps below to generate a Confluent API key.

note

To access the Billing API, Vantage needs the OrganizationAdmin role attached to the service account (instructions provided below). The OrganizationAdmin role provides read/write access; however, Vantage will never perform write operations and will only read from the Billing API and Organizations API.

Create the Connection​

Generate an API key, create a service account, then attach the right role to the service account.

Step 1: Generate an API Key and Service Account​

  1. Log in to the Confluent Cloud console.
  2. From the top right of the console, click the hamburger menu.
  3. Under ADMINISTRATION, click API keys.
  4. Click + Add API key.
    Expand to view example image
    Adding an API key
  5. For Select an account for API key, click Service account.
  6. Select an existing service account or create a new one, then click Next.
    Expand to view example image
    Adding a service account for the key
  7. For Select resource scope for API key, select Cloud resource management. Click Next.
    Expand to view example image
    Adding a service account for the key
  8. Add a name and description for the key, then click Create API key.
    Expand to view example image
    Adding a key name
  9. Copy the displayed key and the secret to add to Vantage. You can also download a copy of the API key from this screen.
    Expand to view example image
    Copy the newly generated key

Step 2: Add the OrganizationAdmin Role to the Service Account​

  1. From the top hamburger menu of the Confluent Cloud console, select Accounts & access.
  2. On the Accounts & access page, select the Service Accounts tab, then open the service account you associated with the integration API key.
    Expand to view example image
    Confluent Account & access screen
  3. Click the Access tab, then click + Add role assignment.
    Expand to view example image
    Confluent add role assignment
  4. Select the OrganizationAdmin role, then click Add.
    Expand to view example image
    Confluent selecting a role

Step: Add the API Key to the Vantage Console​

  1. From the top navigation in Vantage, click Settings.
  2. On the left navigation, select Integrations and select Confluent.
  3. The Confluent integrations page is displayed. Ensure you are on the Connect tab.
  4. At the bottom of the page, click Add API Key and paste your newly generated API key and API secret.
  5. 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 Confluent costs. As soon as the costs are processed, they will be available on your All Resources Cost Report. If you decide to remove your Confluent integration from Vantage, all costs associated with your Confluent 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​

Confluent Kafka Clusters are synced as active resources and available in resource reports.

Confluent Reporting Dimensions​

On Confluent Cost Reports, you can filter costs across several dimensions:

  • Category (e.g., Kafka Storage)
  • Tag (virtual tags created in Vantage for this provider)
  • Resource (resource service ID)
  • Charge Type (e.g., Usage)
  • Organization (organization ID)
  • Service (e.g., Kafka)

You can also view credits or discounts for Confluent costs in Cost Reports.

  1. At the top of any Confluent Cost Report, click Settings.
  2. Then, toggle on/off Credits and/or Discounts.