Advanced parameters for Aiven for Apache Kafka®¶
Below you can find a summary of every configuration option available for Aiven for Apache Kafka® service:
custom_domain=> [‘string’, ‘null’]
Custom domain Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
IP filter Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
Static IP addresses Use static public IP addresses
Allow access to selected service ports from private networks
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
Allow access to selected service ports from the public Internet
Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network
Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network
Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network
Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network
Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network
Allow access to selected service components through Privatelink
Kafka broker configuration values
compression.type Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (‘gzip’, ‘snappy’, ‘lz4’, ‘zstd’). It additionally accepts ‘uncompressed’ which is equivalent to no compression; and ‘producer’ which means retain the original compression codec set by the producer.
group.initial.rebalance.delay.ms The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time.
group.min.session.timeout.ms The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.
group.max.session.timeout.ms The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.
connections.max.idle.ms Idle connections timeout: the server socket processor threads close the connections that idle for longer than this.
max.incremental.fetch.session.cache.slots The maximum number of incremental fetch sessions that the broker will maintain.
message.max.bytes The maximum size of message that the server can receive.
offsets.retention.minutes Log retention window in minutes for offsets topic
log.cleaner.delete.retention.ms How long are delete records retained?
log.cleaner.min.cleanable.ratio Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option.
log.cleaner.max.compaction.lag.ms The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted
log.cleaner.min.compaction.lag.ms The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
log.cleanup.policy The default cleanup policy for segments beyond the retention window
log.flush.interval.messages The number of messages accumulated on a log partition before messages are flushed to disk
log.flush.interval.ms The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used
log.index.interval.bytes The interval with which Kafka adds an entry to the offset index
log.index.size.max.bytes The maximum size in bytes of the offset index
log.message.downconversion.enable This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests.
log.message.timestamp.type Define whether the timestamp in the message is message create time or log append time.
log.message.timestamp.difference.max.ms The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message
log.preallocate Should pre allocate file when create new segment?
log.retention.bytes The maximum size of the log before deleting messages
log.retention.hours The number of hours to keep a log file before deleting it
log.retention.ms The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied.
log.roll.jitter.ms The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used
log.roll.ms The maximum time before a new log segment is rolled out (in milliseconds).
log.segment.bytes The maximum size of a single log file
log.segment.delete.delay.ms The amount of time to wait before deleting a file from the filesystem
auto.create.topics.enable Enable auto creation of topics
min.insync.replicas When a producer sets acks to ‘all’ (or ‘-1’), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.
num.partitions Number of partitions for autocreated topics
default.replication.factor Replication factor for autocreated topics
replica.fetch.max.bytes The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, 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 progress can be made.
replica.fetch.response.max.bytes Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, 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 progress can be made. As such, this is not an absolute maximum.
max.connections.per.ip The maximum number of connections allowed from each ip address (defaults to 2147483647).
producer.purgatory.purge.interval.requests The purge interval (in number of requests) of the producer request purgatory(defaults to 1000).
socket.request.max.bytes The maximum number of bytes in a socket request (defaults to 104857600).
transaction.state.log.segment.bytes The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)).
transaction.remove.expired.transaction.cleanup.interval.ms The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)).
Kafka authentication methods
Enable certificate/SSL authentication
Enable SASL authentication
Enable Kafka Connect service
Kafka Connect configuration values
Client config override policy Defines what client configurations can be overridden by the connector. Default is None
Consumer 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. Default is earliest
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.
Consumer isolation level Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
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 delay between polls when using consumer group management The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
The maximum number of records returned by a single poll The maximum number of records returned in a single call to poll() (defaults to 500).
The interval at which to try committing offsets for tasks The interval at which to try committing offsets for tasks (defaults to 60000).
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).
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.
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.
The timeout used to detect failures when using Kafka’s group management facilities The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
Enable Kafka-REST service
kafka_version=> [‘string’, ‘null’]
Kafka major version
Enable Schema-Registry service
Kafka REST configuration
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.linger.ms Wait for up to the given delay to allow batching records together
consumer.enable.auto.commit If true the consumer’s offset will be periodically committed to Kafka in the background
consumer.request.max.bytes Maximum number of bytes in unencoded message keys and values by a single request
consumer.request.timeout.ms The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached
simpleconsumer.pool.size.max Maximum number of SimpleConsumers that can be instantiated per broker
Schema Registry configuration
topic_name The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It’s only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to _schemas.
leader_eligibility If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to true.