Manage Kafka Client Configurations

This option allows you to manage Kafka client configurations globally for Producer role. A Producer creates a record and publishes it to the Kafka broker whereas a Consumer consumes records from the Kafka broker.
9-5
This option allows you to manage Kafka client configurations globally for Producer role. A Producer creates a record and publishes it to the Kafka broker whereas a Consumer consumes records from the Kafka broker.
Follow these steps:
  1. Open Policy Manager and click
    Tasks, Extensions and Add-Ons
    ,
    Manage Kafka Client Configurations
    .
    The
    Manage Kafka Client Configurations
    dialog opens listing all the existing configurations.
  2. Click
    Add
    to add a new configuration.
    The
    Manage Kafka Client Configuration Properties
    dialog opens.
  3. Enter a name to identify the client configuration and select the
    Enabled
    check-box.
    Only the client configurations that are marked Enabled are listed in the
    Kafka Routing Properties
    dialog in the Route via Kafka assertion. For existing assertions that use these configurations, if the Enabled checkbox is cleared or if the client configuration is deleted, the assertion fails.
  4. By default, the Kafka client
    Role
    is Producer.
  5. Configure the
    Connection
    tab.
    1. Select a Kafka broker's address from the
      Bootstrap Servers
      list, which lists all the servers that are used to identify the Kafka cluster. The server URLs are in
      Host:Port
      format and multiple URLs are either separated by comma or listed on a new line.
    2. Select the
      Enable TLS
      checkbox to enable SSL connection with Kafka server. To use a specific set of TLS cipher suites for this Kafka client connection, click
      Manage Cipher Suites
      . For more information, see Selecting Cipher Suites.
    3. Select a customized Private Key from the drop-down list. For more information, see Manage Private Keys.
  6. Configure the
    Producer
    tab.
    1. Select the
      Enable Idempotence
      checkbox to enable the Producer to deliver exactly one copy of the records to the Kafka cluster topic partition stream. If this checkbox is selected,
      Acknowledgement
      and
      Retries
      options are disabled.
    2. Select an
      Acknowledgement
      option if the
      Enable Idempotence
      checkbox is not selected to detect delivery errors and avoid record loss.
      1. None:
        No acknowledgment is needed.
      2. One
        : Client waits for an acknowledgment from the Kafka broker but it does not wait for full acknowledgement whether all the followers are in sync with the record or not.
      3. All
        : Kafka broker waits for full acknowledgment and so the client commits on seeing this response from the broker.
    3. Specify the number of times a client can try to send the record in the
      Retries
      field if you have not selected the
      Enable Idempotence
      checkbox.
    4. (Optional) Customize the client behavior by adding key-value pairs in the
      Advanced Properties
      text area.
  7. Configure the
    Security
    tab.
    1. Select the
      Authentication
      mechanism from the drop-down list. Only
      PLAIN
      ,
      SCRAM-SHA-256
      , and
      SCRAM-SHA-512
      are supported. Select
      None
      if no authentication is needed.
    2. Add a
      Username
      and select the
      Password
      from the drop-down list.
  8. Click
    OK
    .
Cluster Property
Property
Description
kafka.producer.retries
Specifies the number of times a Kafka Producer client tries to send the record.
Default:
5
The
Retries
field value in the
Manage Kafka Client Configuration Properties
dialog overwrites this cluster property value.