Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure Kafka as a target

Learn how to configure custom meters to use Apache Kafka as a target for data transition in Zuora.

Custom meters can be configured to use Apache Kafka as a target.

Note: Kafka Connections can only be used in Mediation as source or target for Zuora internal Kafka data transition. Connecting to external Kafka as a streaming data source is not supported.
The following table specifies the mediation meter volume limits:

API Sandbox Zuora Developer Sandbox Zuora Central Sandbox
Kafka
  • 4KB single message size
  • 10K messages/ min
  • 4KB single message size
  • 20K messages/ min
  • Same as required for production

The guidelines for Zuora Central Sandbox must be followed for your Production environment.

  1. Navigate to Mediation > Meters
  2. Create a Custom meter.
  3. Select Kafka as the target. The Kafka settings page is displayed. Kafka target settings
  4. Click Select to select an Event Definition on the Kafka settings page. Only event schema import from an AVSC schema is supported.
  5. Under the Kafka Settings section, configure the following settings:
    Setting Configuration
    Connection Select a connection from the Connection drop-down list. To set up a connection, contact Zuora Support.
    Topic Select a topic from Apache Kafka for events output.
    Data Format Select a data format from the Kafka events. If you choose the AVRO format, you must also specify an event definition which is imported from an AVRO schema.
    Key Fields

    Click the Key Fields Format drop-down list to select one or more key fields.

    The output usage event generates the partition key based on the order of key field selections. The key fields are connected by a “_” character to generate a final partition key if multiple fields are selected.

    For example, uom_product_accountId

  6. Click Save to save the Kafka target settings.