Kafka Consumer Configuration Reference for Confluent Platform¶
This topic provides Apache Kafka® consumer configuration parameters. The configuration parameters are organized by order of importance, ranked from high to low.
To learn more about consumers in Kafka, see this free Apache Kafka 101 course. You can find code samples for the consumer in different languages in these guides.
Search by configuration property name¶
Enter a string to search and filter by configuration property name.
key.deserializer¶
Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface.
| Type: | class |
| Default: | |
| Valid Values: | |
| Importance: | high |
value.deserializer¶
Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface.
| Type: | class |
| Default: | |
| Valid Values: | |
| Importance: | high |
bootstrap.servers¶
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
| Type: | list |
| Default: | “” |
| Valid Values: | non-null string |
| Importance: | high |
fetch.min.bytes¶
The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request. The default setting of 1 byte means that fetch requests are answered as soon as that many byte(s) of data is available or the fetch request times out waiting for data to arrive. Setting this to a larger value will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency.
| Type: | int |
| Default: | 1 |
| Valid Values: | [0,…] |
| Importance: | high |
group.id¶
A unique string that identifies the consumer group this consumer belongs to. This property is required if the consumer uses either the group management functionality by using subscribe(topic) or the Kafka-based offset management strategy.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | high |
group.protocol¶
The group protocol consumer should use. We currently support “classic” or “consumer”. If “consumer” is specified, then the consumer group protocol will be used. Otherwise, the classic group protocol will be used.
| Type: | string |
| Default: | classic |
| Valid Values: | (case insensitive) [CONSUMER, CLASSIC] |
| Importance: | high |
heartbeat.interval.ms¶
The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities. Heartbeats are used to ensure that the consumer’s session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances.
| Type: | int |
| Default: | 3000 (3 seconds) |
| Valid Values: | |
| Importance: | high |
max.partition.fetch.bytes¶
The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). See fetch.max.bytes for limiting the consumer request size.
| Type: | int |
| Default: | 1048576 (1 mebibyte) |
| Valid Values: | [0,…] |
| Importance: | high |
session.timeout.ms¶
The timeout used to detect client failures when using Kafka’s group management facility. The client sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this client from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by group.min.session.timeout.ms and group.max.session.timeout.ms.
| Type: | int |
| Default: | 45000 (45 seconds) |
| Valid Values: | |
| Importance: | high |
ssl.key.password¶
The password of the private key in the key store file or the PEM key specified in ‘ssl.keystore.key’.
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.keystore.certificate.chain¶
Certificate chain in the format specified by ‘ssl.keystore.type’. Default SSL engine factory supports only PEM format with a list of X.509 certificates
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.keystore.key¶
Private key in the format specified by ‘ssl.keystore.type’. Default SSL engine factory supports only PEM format with PKCS#8 keys. If the key is encrypted, key password must be specified using ‘ssl.key.password’
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.keystore.location¶
The location of the key store file. This is optional for client and can be used for two-way authentication for client.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.keystore.password¶
The store password for the key store file. This is optional for client and only needed if ‘ssl.keystore.location’ is configured. Key store password is not supported for PEM format.
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.truststore.certificates¶
Trusted certificates in the format specified by ‘ssl.truststore.type’. Default SSL engine factory supports only PEM format with X.509 certificates.
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.truststore.location¶
The location of the trust store file.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | high |
ssl.truststore.password¶
The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format.
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | high |
allow.auto.create.topics¶
Allow automatic topic creation on the broker when subscribing to or assigning a topic. A topic being subscribed to will be automatically created only if the broker allows for it using auto.create.topics.enable broker configuration. This configuration must be set to false when using brokers older than 0.11.0
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | medium |
auto.offset.reset¶
What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted):
- earliest: automatically reset the offset to the earliest offset
- latest: automatically reset the offset to the latest offset
- none: throw exception to the consumer if no previous offset is found for the consumer’s group
- anything else: throw exception to the consumer.
Note that altering partition numbers while setting this config to latest may cause message delivery loss since producers could start to send messages to newly added partitions (i.e. no initial offsets exist yet) before consumers reset their offsets.
| Type: | string |
| Default: | latest |
| Valid Values: | [latest, earliest, none] |
| Importance: | medium |
client.dns.lookup¶
Controls how the client uses DNS lookups. If set to use_all_dns_ips, connect to each returned IP address in sequence until a successful connection is established. After a disconnection, the next IP is used. Once all IPs have been used once, the client resolves the IP(s) from the hostname again (both the JVM and the OS cache DNS name lookups, however). If set to resolve_canonical_bootstrap_servers_only, resolve each bootstrap address into a list of canonical names. After the bootstrap phase, this behaves the same as use_all_dns_ips.
| Type: | string |
| Default: | use_all_dns_ips |
| Valid Values: | [use_all_dns_ips, resolve_canonical_bootstrap_servers_only] |
| Importance: | medium |
connections.max.idle.ms¶
Close idle connections after the number of milliseconds specified by this config.
| Type: | long |
| Default: | 540000 (9 minutes) |
| Valid Values: | |
| Importance: | medium |
default.api.timeout.ms¶
Specifies the timeout (in milliseconds) for client APIs. This configuration is used as the default timeout for all client operations that do not specify a timeout parameter.
| Type: | int |
| Default: | 60000 (1 minute) |
| Valid Values: | [0,…] |
| Importance: | medium |
enable.auto.commit¶
If true the consumer’s offset will be periodically committed in the background.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | medium |
exclude.internal.topics¶
Whether internal topics matching a subscribed pattern should be excluded from the subscription. It is always possible to explicitly subscribe to an internal topic.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | medium |
fetch.max.bytes¶
The maximum amount of data the server should return for a fetch request. Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel.
| Type: | int |
| Default: | 52428800 (50 mebibytes) |
| Valid Values: | [0,…] |
| Importance: | medium |
group.instance.id¶
A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g. process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior.
| Type: | string |
| Default: | null |
| Valid Values: | non-empty string |
| Importance: | medium |
group.remote.assignor¶
The server-side assignor to use. If no assignor is specified, the group coordinator will pick one. This configuration is applied only if group.protocol is set to “consumer”.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
isolation.level¶
Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode.
Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions.
Further, when inread_committedthe seekToEnd method will return the LSO
| Type: | string |
| Default: | read_uncommitted |
| Valid Values: | [read_committed, read_uncommitted] |
| Importance: | medium |
max.poll.interval.ms¶
The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member. For consumers using a non-null group.instance.id which reach this timeout, partitions will not be immediately reassigned. Instead, the consumer will stop sending heartbeats and partitions will be reassigned after expiration of session.timeout.ms. This mirrors the behavior of a static consumer which has shutdown.
| Type: | int |
| Default: | 300000 (5 minutes) |
| Valid Values: | [1,…] |
| Importance: | medium |
max.poll.records¶
The maximum number of records returned in a single call to poll(). Note, that max.poll.records does not impact the underlying fetching behavior. The consumer will cache the records from each fetch request and returns them incrementally from each poll.
| Type: | int |
| Default: | 500 |
| Valid Values: | [1,…] |
| Importance: | medium |
partition.assignment.strategy¶
A list of class names or class types, ordered by preference, of supported partition assignment strategies that the client will use to distribute partition ownership amongst consumer instances when group management is used. Available options are:
org.apache.kafka.clients.consumer.RangeAssignor: Assigns partitions on a per-topic basis.org.apache.kafka.clients.consumer.RoundRobinAssignor: Assigns partitions to consumers in a round-robin fashion.org.apache.kafka.clients.consumer.StickyAssignor: Guarantees an assignment that is maximally balanced while preserving as many existing partition assignments as possible.org.apache.kafka.clients.consumer.CooperativeStickyAssignor: Follows the same StickyAssignor logic, but allows for cooperative rebalancing.
The default assignor is [RangeAssignor, CooperativeStickyAssignor], which will use the RangeAssignor by default, but allows upgrading to the CooperativeStickyAssignor with just a single rolling bounce that removes the RangeAssignor from the list.
Implementing the org.apache.kafka.clients.consumer.ConsumerPartitionAssignor interface allows you to plug in a custom assignment strategy.
| Type: | list |
| Default: | class org.apache.kafka.clients.consumer.RangeAssignor,class org.apache.kafka.clients.consumer.CooperativeStickyAssignor |
| Valid Values: | non-null string |
| Importance: | medium |
receive.buffer.bytes¶
The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used.
| Type: | int |
| Default: | 65536 (64 kibibytes) |
| Valid Values: | [-1,…] |
| Importance: | medium |
request.timeout.ms¶
The configuration controls the maximum amount of time 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.
| Type: | int |
| Default: | 30000 (30 seconds) |
| Valid Values: | [0,…] |
| Importance: | medium |
sasl.client.callback.handler.class¶
The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.
| Type: | class |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.jaas.config¶
JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here. The format for the value is: loginModuleClass controlFlag (optionName=optionValue)*;. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required;
| Type: | password |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.kerberos.service.name¶
The Kerberos principal name that Kafka runs as. This can be defined either in Kafka’s JAAS config or in Kafka’s config.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.login.callback.handler.class¶
The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler
| Type: | class |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.login.class¶
The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin
| Type: | class |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.mechanism¶
SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism.
| Type: | string |
| Default: | GSSAPI |
| Valid Values: | |
| Importance: | medium |
sasl.oauthbearer.jwks.endpoint.url¶
The OAuth/OIDC provider URL from which the provider’s JWKS (JSON Web Key Set) can be retrieved. The URL can be HTTP(S)-based or file-based. If the URL is HTTP(S)-based, the JWKS data will be retrieved from the OAuth/OIDC provider via the configured URL on broker startup. All then-current keys will be cached on the broker for incoming requests. If an authentication request is received for a JWT that includes a “kid” header claim value that isn’t yet in the cache, the JWKS endpoint will be queried again on demand. However, the broker polls the URL every sasl.oauthbearer.jwks.endpoint.refresh.ms milliseconds to refresh the cache with any forthcoming keys before any JWT requests that include them are received. If the URL is file-based, the broker will load the JWKS file from a configured location on startup. In the event that the JWT includes a “kid” header value that isn’t in the JWKS file, the broker will reject the JWT and authentication will fail.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
sasl.oauthbearer.token.endpoint.url¶
The URL for the OAuth/OIDC identity provider. If the URL is HTTP(S)-based, it is the issuer’s token endpoint URL to which requests will be made to login based on the configuration in sasl.jaas.config. If the URL is file-based, it specifies a file containing an access token (in JWT serialized form) issued by the OAuth/OIDC identity provider to use for authorization.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
security.protocol¶
Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
| Type: | string |
| Default: | PLAINTEXT |
| Valid Values: | (case insensitive) [SASL_SSL, PLAINTEXT, SSL, SASL_PLAINTEXT] |
| Importance: | medium |
send.buffer.bytes¶
The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used.
| Type: | int |
| Default: | 131072 (128 kibibytes) |
| Valid Values: | [-1,…] |
| Importance: | medium |
socket.connection.setup.timeout.max.ms¶
The maximum amount of time the client will wait for the socket connection to be established. The connection setup timeout will increase exponentially for each consecutive connection failure up to this maximum. To avoid connection storms, a randomization factor of 0.2 will be applied to the timeout resulting in a random range between 20% below and 20% above the computed value.
| Type: | long |
| Default: | 30000 (30 seconds) |
| Valid Values: | |
| Importance: | medium |
socket.connection.setup.timeout.ms¶
The amount of time the client will wait for the socket connection to be established. If the connection is not built before the timeout elapses, clients will close the socket channel. This value is the initial backoff value and will increase exponentially for each consecutive connection failure, up to the socket.connection.setup.timeout.max.ms value.
| Type: | long |
| Default: | 10000 (10 seconds) |
| Valid Values: | |
| Importance: | medium |
ssl.enabled.protocols¶
The list of protocols enabled for SSL connections. The default is ‘TLSv1.2,TLSv1.3’ when running with Java 11 or newer, ‘TLSv1.2’ otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for ssl.protocol.
| Type: | list |
| Default: | TLSv1.2 |
| Valid Values: | |
| Importance: | medium |
ssl.keystore.type¶
The file format of the key store file. This is optional for client. The values currently supported by the default ssl.engine.factory.class are [JKS, PKCS12, PEM].
| Type: | string |
| Default: | JKS |
| Valid Values: | |
| Importance: | medium |
ssl.protocol¶
The SSL protocol used to generate the SSLContext. The default is ‘TLSv1.3’ when running with Java 11 or newer, ‘TLSv1.2’ otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are ‘TLSv1.2’ and ‘TLSv1.3’. ‘TLS’, ‘TLSv1.1’, ‘SSL’, ‘SSLv2’ and ‘SSLv3’ may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and ‘ssl.enabled.protocols’, clients will downgrade to ‘TLSv1.2’ if the server does not support ‘TLSv1.3’. If this config is set to ‘TLSv1.2’, clients will not use ‘TLSv1.3’ even if it is one of the values in ssl.enabled.protocols and the server only supports ‘TLSv1.3’.
| Type: | string |
| Default: | TLSv1.2 |
| Valid Values: | |
| Importance: | medium |
ssl.provider¶
The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | medium |
ssl.truststore.type¶
The file format of the trust store file. The values currently supported by the default ssl.engine.factory.class are [JKS, PKCS12, PEM].
| Type: | string |
| Default: | JKS |
| Valid Values: | |
| Importance: | medium |
auto.commit.interval.ms¶
The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true.
| Type: | int |
| Default: | 5000 (5 seconds) |
| Valid Values: | [0,…] |
| Importance: | low |
auto.include.jmx.reporter¶
Deprecated. Whether to automatically include JmxReporter even if it’s not listed in metric.reporters. This configuration will be removed in Kafka 4.0, users should instead include org.apache.kafka.common.metrics.JmxReporter in metric.reporters in order to enable the JmxReporter.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | low |
check.crcs¶
Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | low |
client.id¶
An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
| Type: | string |
| Default: | “” |
| Valid Values: | |
| Importance: | low |
client.rack¶
A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config ‘broker.rack’
| Type: | string |
| Default: | “” |
| Valid Values: | |
| Importance: | low |
enable.metrics.push¶
Whether to enable pushing of client metrics to the cluster, if the cluster has a client metrics subscription which matches this client.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | low |
fetch.max.wait.ms¶
The maximum amount of time the server will block before answering the fetch request there isn’t sufficient data to immediately satisfy the requirement given by fetch.min.bytes.
| Type: | int |
| Default: | 500 |
| Valid Values: | [0,…] |
| Importance: | low |
interceptor.classes¶
A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.consumer.ConsumerInterceptor interface allows you to intercept (and possibly mutate) records received by the consumer. By default, there are no interceptors.
| Type: | list |
| Default: | “” |
| Valid Values: | non-null string |
| Importance: | low |
metadata.max.age.ms¶
The period of time in milliseconds after which we force a refresh of metadata even if we haven’t seen any partition leadership changes to proactively discover any new brokers or partitions.
| Type: | long |
| Default: | 300000 (5 minutes) |
| Valid Values: | [0,…] |
| Importance: | low |
metadata.recovery.strategy¶
Controls how the client recovers when none of the brokers known to it is available. If set to none, the client fails. If set to rebootstrap, the client repeats the bootstrap process using bootstrap.servers. Rebootstrapping is useful when a client communicates with brokers so infrequently that the set of brokers may change entirely before the client refreshes metadata. Metadata recovery is triggered when all last-known brokers appear unavailable simultaneously. Brokers appear unavailable when disconnected and no current retry attempt is in-progress. Consider increasing reconnect.backoff.ms and reconnect.backoff.max.ms and decreasing socket.connection.setup.timeout.ms and socket.connection.setup.timeout.max.ms for the client.
| Type: | string |
| Default: | none |
| Valid Values: | (case insensitive) [REBOOTSTRAP, NONE] |
| Importance: | low |
metric.reporters¶
A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics.
| Type: | list |
| Default: | “” |
| Valid Values: | non-null string |
| Importance: | low |
metrics.num.samples¶
The number of samples maintained to compute metrics.
| Type: | int |
| Default: | 2 |
| Valid Values: | [1,…] |
| Importance: | low |
metrics.recording.level¶
The highest recording level for metrics.
| Type: | string |
| Default: | INFO |
| Valid Values: | [INFO, DEBUG, TRACE] |
| Importance: | low |
metrics.sample.window.ms¶
The window of time a metrics sample is computed over.
| Type: | long |
| Default: | 30000 (30 seconds) |
| Valid Values: | [0,…] |
| Importance: | low |
reconnect.backoff.max.ms¶
The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms.
| Type: | long |
| Default: | 1000 (1 second) |
| Valid Values: | [0,…] |
| Importance: | low |
reconnect.backoff.ms¶
The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker. This value is the initial backoff value and will increase exponentially for each consecutive connection failure, up to the reconnect.backoff.max.ms value.
| Type: | long |
| Default: | 50 |
| Valid Values: | [0,…] |
| Importance: | low |
retry.backoff.max.ms¶
The maximum amount of time in milliseconds to wait when retrying a request to the broker that has repeatedly failed. If provided, the backoff per client will increase exponentially for each failed request, up to this maximum. To prevent all clients from being synchronized upon retry, a randomized jitter with a factor of 0.2 will be applied to the backoff, resulting in the backoff falling within a range between 20% below and 20% above the computed value. If retry.backoff.ms is set to be higher than retry.backoff.max.ms, then retry.backoff.max.ms will be used as a constant backoff from the beginning without any exponential increase
| Type: | long |
| Default: | 1000 (1 second) |
| Valid Values: | [0,…] |
| Importance: | low |
retry.backoff.ms¶
The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. This value is the initial backoff value and will increase exponentially for each failed request, up to the retry.backoff.max.ms value.
| Type: | long |
| Default: | 100 |
| Valid Values: | [0,…] |
| Importance: | low |
sasl.kerberos.kinit.cmd¶
Kerberos kinit command path.
| Type: | string |
| Default: | /usr/bin/kinit |
| Valid Values: | |
| Importance: | low |
sasl.kerberos.min.time.before.relogin¶
Login thread sleep time between refresh attempts.
| Type: | long |
| Default: | 60000 |
| Valid Values: | |
| Importance: | low |
sasl.kerberos.ticket.renew.jitter¶
Percentage of random jitter added to the renewal time.
| Type: | double |
| Default: | 0.05 |
| Valid Values: | |
| Importance: | low |
sasl.kerberos.ticket.renew.window.factor¶
Login thread will sleep until the specified window factor of time from last refresh to ticket’s expiry has been reached, at which time it will try to renew the ticket.
| Type: | double |
| Default: | 0.8 |
| Valid Values: | |
| Importance: | low |
sasl.login.connect.timeout.ms¶
The (optional) value in milliseconds for the external authentication provider connection timeout. Currently applies only to OAUTHBEARER.
| Type: | int |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.login.read.timeout.ms¶
The (optional) value in milliseconds for the external authentication provider read timeout. Currently applies only to OAUTHBEARER.
| Type: | int |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.login.refresh.buffer.seconds¶
The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
| Type: | short |
| Default: | 300 |
| Valid Values: | [0,…,3600] |
| Importance: | low |
sasl.login.refresh.min.period.seconds¶
The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
| Type: | short |
| Default: | 60 |
| Valid Values: | [0,…,900] |
| Importance: | low |
sasl.login.refresh.window.factor¶
Login refresh thread will sleep until the specified window factor relative to the credential’s lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER.
| Type: | double |
| Default: | 0.8 |
| Valid Values: | [0.5,…,1.0] |
| Importance: | low |
sasl.login.refresh.window.jitter¶
The maximum amount of random jitter relative to the credential’s lifetime that is added to the login refresh thread’s sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER.
| Type: | double |
| Default: | 0.05 |
| Valid Values: | [0.0,…,0.25] |
| Importance: | low |
sasl.login.retry.backoff.max.ms¶
The (optional) value in milliseconds for the maximum wait between login attempts to the external authentication provider. Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting. Currently applies only to OAUTHBEARER.
| Type: | long |
| Default: | 10000 (10 seconds) |
| Valid Values: | |
| Importance: | low |
sasl.login.retry.backoff.ms¶
The (optional) value in milliseconds for the initial wait between login attempts to the external authentication provider. Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting. Currently applies only to OAUTHBEARER.
| Type: | long |
| Default: | 100 |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.audience¶
The value to be added to the Audience claim “aud” which will be included in the client assertion created locally
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.expiration¶
The (Optional) expiration time for the client assertion in minutesThe default value is 5 minutes
| Type: | int |
| Default: | 5 |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.include.jti.claim¶
The (optional) setting for specifying whether to include jti claim or not
| Type: | boolean |
| Default: | false |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.include.nbf.claim¶
The (optional) setting for specifying whether to include “not before” (nbf) claim or notIf set to true, nbf claim with (current time - 1 minute) will be included in the client assertion
| Type: | boolean |
| Default: | false |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.issuer¶
The value to be added to the Issuer claim “iss” which will be included in the client assertion created locally
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.location¶
The location/path on disc at which a signed client assertion is presentThis will be passed directly to the token endpoint.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.private.key¶
The location for the private key to be used for signing client assertion in PEM formatRequired for local client assertion creation
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.private.key.passphrase¶
The passphrase required for decrypting the private key (in case of PKCS#8 format pem file)
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clientassertion.subject¶
The value to be added to the Subject claim “sub” which will be included in the client assertion created locally
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.clock.skew.seconds¶
The (optional) value in seconds to allow for differences between the time of the OAuth/OIDC identity provider and the broker.
| Type: | int |
| Default: | 30 |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.expected.audience¶
The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. The JWT will be inspected for the standard OAuth “aud” claim and if this value is set, the broker will match the value from JWT’s “aud” claim to see if there is an exact match. If there is no match, the broker will reject the JWT and authentication will fail.
| Type: | list |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.expected.issuer¶
The (optional) setting for the broker to use to verify that the JWT was created by the expected issuer. The JWT will be inspected for the standard OAuth “iss” claim and if this value is set, the broker will match it exactly against what is in the JWT’s “iss” claim. If there is no match, the broker will reject the JWT and authentication will fail.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.jwks.endpoint.refresh.ms¶
The (optional) value in milliseconds for the broker to wait between refreshing its JWKS (JSON Web Key Set) cache that contains the keys to verify the signature of the JWT.
| Type: | long |
| Default: | 3600000 (1 hour) |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms¶
The (optional) value in milliseconds for the maximum wait between attempts to retrieve the JWKS (JSON Web Key Set) from the external authentication provider. JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.
| Type: | long |
| Default: | 10000 (10 seconds) |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.jwks.endpoint.retry.backoff.ms¶
The (optional) value in milliseconds for the initial wait between JWKS (JSON Web Key Set) retrieval attempts from the external authentication provider. JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.
| Type: | long |
| Default: | 100 |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.scope.claim.name¶
The OAuth claim for the scope is often named “scope”, but this (optional) setting can provide a different name to use for the scope included in the JWT payload’s claims if the OAuth/OIDC provider uses a different name for that claim.
| Type: | string |
| Default: | scope |
| Valid Values: | |
| Importance: | low |
sasl.oauthbearer.sub.claim.name¶
The OAuth claim for the subject is often named “sub”, but this (optional) setting can provide a different name to use for the subject included in the JWT payload’s claims if the OAuth/OIDC provider uses a different name for that claim.
| Type: | string |
| Default: | sub |
| Valid Values: | |
| Importance: | low |
security.providers¶
A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement the org.apache.kafka.common.security.auth.SecurityProviderCreator interface.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
ssl.cipher.suites¶
A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported.
| Type: | list |
| Default: | null |
| Valid Values: | |
| Importance: | low |
ssl.endpoint.identification.algorithm¶
The endpoint identification algorithm to validate server hostname using server certificate.
| Type: | string |
| Default: | https |
| Valid Values: | |
| Importance: | low |
ssl.engine.factory.class¶
The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects. Default value is org.apache.kafka.common.security.ssl.DefaultSslEngineFactory. Alternatively, setting this to org.apache.kafka.common.security.ssl.CommonNameLoggingSslEngineFactory will log the common name of expired SSL certificates used by clients to authenticate at any of the brokers with log level INFO. Note that this will cause a tiny delay during establishment of new connections from mTLS clients to brokers due to the extra code for examining the certificate chain provided by the client. Note further that the implementation uses a custom truststore based on the standard Java truststore and thus might be considered a security risk due to not being as mature as the standard one.
| Type: | class |
| Default: | null |
| Valid Values: | |
| Importance: | low |
ssl.keymanager.algorithm¶
The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.
| Type: | string |
| Default: | SunX509 |
| Valid Values: | |
| Importance: | low |
ssl.secure.random.implementation¶
The SecureRandom PRNG implementation to use for SSL cryptography operations.
| Type: | string |
| Default: | null |
| Valid Values: | |
| Importance: | low |
ssl.trustmanager.algorithm¶
The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.
| Type: | string |
| Default: | PKIX |
| Valid Values: | |
| Importance: | low |
Note
This website includes content developed at the Apache Software Foundation under the terms of the Apache License v2.