Kafka Properties
This page displays the following fields.
Table 8-2 Kafka Properties
| Field(* indicates a required field) | Value | Description |
|---|---|---|
| Primary IP and port * | 10.167.217.7:8390 | IP and Port of primary Kafka cluster.
Example of IPv4 input: 10.167.217.7:8392. Example of IPv6 input: [2605:2700:0:3::4713:93e3]:80 Note: IP and Port are segregated using: (colon) Default: NA Range: Any valid IPv4/IPv6 address with port |
| Backup IP and port * | 10.167.217.7:8390 | IP and port of backup Kafka cluster, which will be used
when primary is not available.
Example of IPv4 input: 10.167.217.7:8392. Example of IPv6 input: [2605:2700:0:3::4713:93e3]:80 Note: IP and Port are segregated using: (colon) Default: NA Range: Any valid IPv4/IPv6 address with port |
| Topic name * | Defines Kafka's topic name, which is a fundamental unit
for event or message organization. Messages with the same topic name
will be appended one after another creating a Log file, producers can
push messages into the tail of these logs while consumers pull messages
off from the head. It is possible to perform logical segregation between
messages and events, which works the same concept of different tables
having different types of data in a database.
Topic Names are limited to 249 characters. Default: NA Range: Topic name can include the following characters: a-z, A-Z, 0-9, . (dot), _ (underscore), and - (hyphen). |
|
| Client ID * | Mds2201-DNO00 | Client ID is a string to pass to the server when requests
are made. The purpose of Client ID is to track the source of requests
beyond just IP/port by allowing a logical application name to be
included in server-side request logging.
Default: NA Range: The client name can be up to 255 characters in length, and can include the following characters: a-z, A-Z, 0-9, . (dot), _ (underscore), and - (hyphen). |
| Compression codec * | Gzip | Compression codec to use for compressing message sets.
Default: Gzip Range: None, Gzip, Snappy, Lz4 |
| Compression level * | 0 | Compression level parameter for algorithm selected by
configuration property compression.codec. Higher values results in
better compression at the cost of more CPU usage.
Default: 0 Range: (0-9) for gzip, (0-12) for lz4, only 0 for snappy. |
| Batch size * | 16384 | Measures batch size in total bytes instead of the number
of messages. It controls how many bytes of data to collect before
sending messages to the Kafka broker. Batch size should be greater than
max record size
Default: 16384 Range: 2048 - 2147483647 |
| Linger * | 10 | Delay in milliseconds to wait for messages in the
producer queue to accumulate before constructing message batches
(MessageSets) to transmit to brokers.
Default: 10 Range: 0-900000 |
| Number of acknowledgments * | 1 | This field indicates the number of acknowledgements the
leader broker must receive from ISR brokers before responding to the
request. 0=Broker does not send any response/ack to client, *-1* or
all=Broker will block until message is committed by all in sync replicas
(ISRs).
Default: 1 Range: 1 or all, 0, 1 |
| Security protocol * | SSL | Protocol used to communicate with brokers.
Default: SSL Range: PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL Note: Using PLAINTEXT as Security Protocol is not recommended. |
| Connection timeout * | 1000 | Indicates the time (in milliseconds) to wait after a
connection to a Kafka cluster has been requested. If the timeout is
over, then the connection will be deemed unsuccessful.
Default: 1000 Range: 1000 - 3000 |
| SSL Protocol * | TLSv1.3 | The SSL protocol used to generate the SSLContext.
Default: TLSv1.3 Range: TLSv1.2, TLSv1.3 |
| Max Record Size * | 2048 | Maximum size of single record that can be sent over
Kafka.
Default: 2048 Range: 1000 - 1000000000 |
| Delivery Timeout * | 120000 | An upper bound on the time (in milliseconds) to report
success or failure after a call to send returns.
Default: 120000 Range: 0-300000 |
| Request Timeout * | 30000 | This controls the maximum amount of time (in
milliseconds) the client will wait for the response of a request. If the
response is not received before the timeout elapses, the client will
resend the request if necessary or fail the request if retries are
exhausted.
Default: 30000 Range: 0-120000 |
| SSL
Properties Note: The SSL properties are displayed when SSL is selected in Security Protocol. |
||
| SSL CA | NA | Filename of CA file to use in certificate verification. |
| SSL Certificate | NA | Filename of file in pem format containing the client certificate as well as any CA certificates needed to establish the certificate's authenticity. |
| SSL Key | NA | Filename containing the client private key. |
| SSL Key password | NA | Password to be used when loading the certificate chain. |
| SASL_Plaintext
Properties Note: The SASL_Plaintext Properties properties are displayed when SASL_Plaintext Properties is selected in Security Protocol. |
||
| SASL Mechanisms | GSSAPI | SASL mechanism to use for authentication.
Default: GSSAPI Range: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, OAUTHBEARER |
| SASL Kerberos Service Name | kafka | Kerberos principal name that Kafka runs as, not including
/hostname@REALM.
Default: kafka |
| SASL Kerberos Principal | kafkaclient | This client's Kerberos principal name.
Note: This is not supported on Windows, the logon user's principal is used. Default: kafkaclient |
| SASL Kerberos Kinit Cmd | NA | Shell command to refresh or acquire the client's Kerberos
ticket. This command is executed on client creation and every
Default: kinit -R -t '%{sasl.kerberos.keytab}' -k %{sasl.kerberos.principal} || kinit -t '%{sasl.kerberos.keytab}' -k %{sasl.kerberos.pricipal} |
| SASL Kerberos Keytab | NA | Path to Kerberos keytab file. This configuration property is only used as a variable in sasl.kerberos.kinit.cmd as ... -t '%{sasl.kerberos.keytab}'. |
| SASL Kerberos Min Time Before Relogin | 60000 | Minimum time in milliseconds between key refresh
attempts. Disable automatic key refresh by setting this property to 0.
Default: 60000 Range: 0-86400000 |
| SASL Username | NA | SASL username for use with the PLAIN and SASL-SCRAM-.. mechanisms |
| SASL Password | SASL password for use with the PLAIN and SASL-SCRAM-.. mechanism | |
Select Apply to save the changes, or select Cancel to discard the changes.