Connecting to Apache Kafka

Prev Next

When connecting to Apache Kafka from the Syniti Knowledge Platform (SKP), provide the following connection properties to establish a secure and reliable connection. This article explains each property to understand what information is required and how it is used.

When you are in the Create Connection page,

  1. Select Kafka from the Type list and enter the following details:

    Property

    Description

    Notes

    Name (Required)

    Name of the Kafka connection unique to the SKP.

    Not applicable

    Description

    Enter a description that briefly states the purpose of this connection.

    Not applicable

    Bootstrap Servers (Required)

    A comma-separated list of Kafka broker host:port addresses used to discover the cluster. For example, broker1:9092,broker2:9092.

    The brokers that Kafka advertises must also be reachable. The SKP will use these bootstrap servers to discover the full cluster topology and establish connections to all broker nodes. At least one broker must be operational for the connection to succeed.

    Client ID

    An optional identifier reported to the brokers for diagnostics and logging purposes.

    A unique client ID helps brokers track and identify your connection in logs and monitoring systems. If left blank, Kafka will generate a default identifier. Recommended format, skp-kafka-client-<environment>.

    Request Timeout (milliseconds)

    The time in milliseconds to wait for a response from the broker before timing out.

    Default: 30000 (30 seconds). Adjust based on your network latency and broker response times. Higher values are useful for unstable networks, while lower values help detect broker failures faster.

    Security Protocol

    The protocol used to communicate with Kafka brokers.

    Options: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. See Kafka Security Protocol Documentation. Choose based on your Kafka cluster's security configuration.

    Advanced Options

    Use the + Add Property button to add any advanced Kafka connection properties.

    Not applicable

    Extended Properties

    Use the + Add Property button to add any additional connection properties.

    Not applicable

Create a Connection