Skip to content

Commit

Permalink
Kafka - Update Advanced parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
Hemant-Mulchandani authored Aug 22, 2023
1 parent 8c5f233 commit c1e2ead
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions includes/config-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,36 @@

**Allow access to selected service ports from private networks**

``kafka``
~~~~~~~~~
*boolean*

**Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``kafka_connect``
~~~~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``kafka_rest``
~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``prometheus``
~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``schema_registry``
~~~~~~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**



``public_access``
Expand Down Expand Up @@ -457,18 +481,42 @@

**Offset flush timeout** Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).

``producer_batch_size``
~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The batch size in bytes the producer will attempt to collect for the same partition before publishing to broker** This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).

``producer_buffer_memory``
~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The total bytes of memory the producer can use to buffer records waiting to be sent to the broker** The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).

``producer_compression_type``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**The default compression type for producers** Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.

``producer_linger_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*

**Wait for up to the given delay to allow batching records together** This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.

``producer_max_request_size``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The maximum size of a request in bytes** This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.

``scheduled_rebalance_max_delay_ms``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The maximum delay of rebalancing connector workers** The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.

``session_timeout_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*
Expand Down Expand Up @@ -501,6 +549,14 @@



``kafka_rest_authorization``
----------------------------
*boolean*

**Enable authorization in Kafka-REST service**



``kafka_rest_config``
---------------------
*object*
Expand All @@ -513,12 +569,24 @@

**producer.acks** The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set to 'all' or '-1', the leader will wait for the full set of in-sync replicas to acknowledge the record.

``producer_compression_type``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**producer.compression.type** Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.

``producer_linger_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*

**producer.linger.ms** Wait for up to the given delay to allow batching records together

``producer_max_request_size``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**producer.max.request.size** The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size.

``consumer_enable_auto_commit``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*boolean*
Expand All @@ -545,6 +613,26 @@



``tiered_storage``
------------------
*object*

**Tiered storage configuration**

``enabled``
~~~~~~~~~~~
*boolean*

**Enabled** Whether to enable the tiered storage functionality

``local_cache``
~~~~~~~~~~~~~~~
*object*

**Local cache** Local cache configuration



``schema_registry_config``
--------------------------
*object*
Expand Down

0 comments on commit c1e2ead

Please sign in to comment.