Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure Kafka as a source

Learn how to configure custom meters to use Apache Kafka as a source, including setting up connections, selecting topics, and configuring data formats.

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

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 source. The Kafka settings page is displayed. Kafka source 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, see Create Kafka connections in meters.
    Topic Select a topic from Apache Kafka for event ingestion.
    Data Format Select a data format from the Kafka events. You must ensure that all the events in the Kafka topic must be in the same format, else the message ingestion fails.

    For example, use the event definition generated from the AVRO data file for the AVRO data format.

    Offset Reset Strategy Select a value from the following options:
    • Latest: Selecting this option causes the meter to ignore the existing data events in the Kafka topic and only ingest the new events added to the topic.
    • Earliest: Selecting this option makes the meter ingest all the data events, including the existing data in the Kafka topic, and the new events added to the topic path.
  6. Click Save to save the Kafka source settings.