camel-vertx-kafka-kafka-connector sink configuration

Connector Description: Sent and receive messages to/from an Apache Kafka broker using vert.x Kafka client

When using camel-vertx-kafka-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-vertx-kafka-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.vertxkafka.CamelVertxkafkaSinkConnector

The camel-vertx-kafka sink connector supports 154 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.topic

Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic.

null

true

HIGH

camel.sink.endpoint.additionalProperties

Sets additional properties for either kafka consumer or kafka producer in case they can’t be set directly on the camel configurations (e.g: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro

null

false

MEDIUM

camel.sink.endpoint.bootstrapServers

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).

null

false

MEDIUM

camel.sink.endpoint.clientDnsLookup

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. If set to default (deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses. One of: [default] [use_all_dns_ips] [resolve_canonical_bootstrap_servers_only]

"use_all_dns_ips"

false

MEDIUM

camel.sink.endpoint.clientId

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.

null

false

MEDIUM

camel.sink.endpoint.connectionsMaxIdleMs

Close idle connections after the number of milliseconds specified by this config.

540000L

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

camel.sink.endpoint.interceptorClasses

A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.producer.ProducerInterceptor interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors.

null

false

MEDIUM

camel.sink.endpoint.metadataMaxAgeMs

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.

300000L

false

MEDIUM

camel.sink.endpoint.metricReporters

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.

null

false

MEDIUM

camel.sink.endpoint.metricsNumSamples

The number of samples maintained to compute metrics.

2

false

MEDIUM

camel.sink.endpoint.metricsRecordingLevel

The highest recording level for metrics. One of: [INFO] [DEBUG] [TRACE]

"INFO"

false

MEDIUM

camel.sink.endpoint.metricsSampleWindowMs

The window of time a metrics sample is computed over.

30000L

false

MEDIUM

camel.sink.endpoint.partitionId

The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config

null

false

MEDIUM

camel.sink.endpoint.receiveBufferBytes

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.

32768

false

MEDIUM

camel.sink.endpoint.reconnectBackoffMaxMs

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.

1000L

false

MEDIUM

camel.sink.endpoint.reconnectBackoffMs

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.

50L

false

MEDIUM

camel.sink.endpoint.requestTimeoutMs

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. This should be larger than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries.

30000

false

MEDIUM

camel.sink.endpoint.retryBackoffMs

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.

100L

false

MEDIUM

camel.sink.endpoint.sendBufferBytes

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.

131072

false

MEDIUM

camel.sink.endpoint.socketConnectionSetupTimeout MaxMs

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.

127000L

false

MEDIUM

camel.sink.endpoint.socketConnectionSetupTimeoutMs

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.

10000L

false

MEDIUM

camel.sink.endpoint.acks

The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed: acks=0 If set to zero then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retries configuration will not take effect (as the client won’t generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee. This is equivalent to the acks=-1 setting. One of: [all] [-1] [0] [1]

"1"

false

MEDIUM

camel.sink.endpoint.batchSize

The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size. Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records.

16384

false

MEDIUM

camel.sink.endpoint.bufferMemory

The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will block for max.block.ms after which it will throw an exception.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests.

33554432L

false

MEDIUM

camel.sink.endpoint.compressionType

The compression type for all data generated by the producer. The default is none (i.e. no compression). Valid values are none, gzip, snappy, lz4, or zstd. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).

"none"

false

MEDIUM

camel.sink.endpoint.deliveryTimeoutMs

An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures. The producer may report failure to send a record earlier than this config if either an unrecoverable error is encountered, the retries have been exhausted, or the record is added to a batch which reached an earlier delivery expiration deadline. The value of this config should be greater than or equal to the sum of request.timeout.ms and linger.ms.

120000

false

MEDIUM

camel.sink.endpoint.enableIdempotence

When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5, retries to be greater than 0 and acks must be 'all'. If these values are not explicitly set by the user, suitable values will be chosen. If incompatible values are set, a ConfigException will be thrown.

false

false

MEDIUM

camel.sink.endpoint.keySerializer

Serializer class for key that implements the org.apache.kafka.common.serialization.Serializer interface.

"org.apache.kafka.common.serialization.StringSerializer"

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

false

MEDIUM

camel.sink.endpoint.lingerMs

The producer groups together any records that arrive in between request transmissions into a single batched request. Normally this occurs only under load when records arrive faster than they can be sent out. However in some circumstances the client may want to reduce the number of requests even under moderate load. This setting accomplishes this by adding a small amount of artificial delay—that is, rather than immediately sending out a record the producer will wait for up to the given delay to allow other records to be sent so that the sends can be batched together. This can be thought of as analogous to Nagle’s algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e. no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absence of load.

0L

false

MEDIUM

camel.sink.endpoint.maxBlockMs

The configuration controls how long the KafkaProducer’s send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block. For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout). For partitionsFor() this timeout bounds the time spent waiting for metadata if it is unavailable. The transaction-related methods always block, but may timeout if the transaction coordinator could not be discovered or did not respond within the timeout.

60000L

false

MEDIUM

camel.sink.endpoint.maxInFlightRequestsPer Connection

The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled).

5

false

MEDIUM

camel.sink.endpoint.maxRequestSize

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. This is also effectively a cap on the maximum uncompressed record batch size. Note that the server has its own cap on the record batch size (after compression if compression is enabled) which may be different from this.

1048576

false

MEDIUM

camel.sink.endpoint.metadataMaxIdleMs

Controls how long the producer will cache metadata for a topic that’s idle. If the elapsed time since a topic was last produced to exceeds the metadata idle duration, then the topic’s metadata is forgotten and the next access to it will force a metadata fetch request.

300000L

false

MEDIUM

camel.sink.endpoint.partitionerClass

Partitioner class that implements the org.apache.kafka.clients.producer.Partitioner interface.

"org.apache.kafka.clients.producer.internals.DefaultPartitioner"

false

MEDIUM

camel.sink.endpoint.retries

Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error. Note that this retry is no different than if the client resent the record upon receiving the error. Allowing retries without setting max.in.flight.requests.per.connection to 1 will potentially change the ordering of records because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds, then the records in the second batch may appear first. Note additionally that produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior.

2147483647

false

MEDIUM

camel.sink.endpoint.transactionalId

The TransactionalId to use for transactional delivery. This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions. If no TransactionalId is provided, then the producer is limited to idempotent delivery. If a TransactionalId is configured, enable.idempotence is implied. By default the TransactionId is not configured, which means transactions cannot be used. Note that, by default, transactions require a cluster of at least three brokers which is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor.

null

false

MEDIUM

camel.sink.endpoint.transactionTimeoutMs

The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with a InvalidTxnTimeoutException error.

60000

false

MEDIUM

camel.sink.endpoint.valueSerializer

Serializer class for value that implements the org.apache.kafka.common.serialization.Serializer interface.

"org.apache.kafka.common.serialization.StringSerializer"

false

MEDIUM

camel.sink.endpoint.saslClientCallbackHandlerClass

The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.

null

false

MEDIUM

camel.sink.endpoint.saslJaasConfig

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;

null

false

MEDIUM

camel.sink.endpoint.saslKerberosKinitCmd

Kerberos kinit command path.

"/usr/bin/kinit"

false

MEDIUM

camel.sink.endpoint.saslKerberosMinTimeBefore Relogin

Login thread sleep time between refresh attempts.

60000L

false

MEDIUM

camel.sink.endpoint.saslKerberosServiceName

The Kerberos principal name that Kafka runs as. This can be defined either in Kafka’s JAAS config or in Kafka’s config.

null

false

MEDIUM

camel.sink.endpoint.saslKerberosTicketRenewJitter

Percentage of random jitter added to the renewal time.

0.05D

false

MEDIUM

camel.sink.endpoint.saslKerberosTicketRenewWindow 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.

0.8D

false

MEDIUM

camel.sink.endpoint.saslLoginCallbackHandlerClass

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

null

false

MEDIUM

camel.sink.endpoint.saslLoginClass

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

null

false

MEDIUM

camel.sink.endpoint.saslLoginRefreshBufferSeconds

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.

300

false

MEDIUM

camel.sink.endpoint.saslLoginRefreshMinPeriod 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.

60

false

MEDIUM

camel.sink.endpoint.saslLoginRefreshWindowFactor

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.

0.8D

false

MEDIUM

camel.sink.endpoint.saslLoginRefreshWindowJitter

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.

0.05D

false

MEDIUM

camel.sink.endpoint.saslMechanism

SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism.

"GSSAPI"

false

MEDIUM

camel.sink.endpoint.securityProtocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

"PLAINTEXT"

false

MEDIUM

camel.sink.endpoint.securityProviders

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.

null

false

MEDIUM

camel.sink.endpoint.sslCipherSuites

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.

null

false

MEDIUM

camel.sink.endpoint.sslEnabledProtocols

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.

"TLSv1.2,TLSv1.3"

false

MEDIUM

camel.sink.endpoint.sslEndpointIdentification Algorithm

The endpoint identification algorithm to validate server hostname using server certificate.

"https"

false

MEDIUM

camel.sink.endpoint.sslEngineFactoryClass

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

null

false

MEDIUM

camel.sink.endpoint.sslKeymanagerAlgorithm

The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.

"SunX509"

false

MEDIUM

camel.sink.endpoint.sslKeyPassword

The password of the private key in the key store file orthe PEM key specified in ssl.keystore.key'. This is required for clients only if two-way authentication is configured.

null

false

MEDIUM

camel.sink.endpoint.sslKeystoreCertificateChain

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

null

false

MEDIUM

camel.sink.endpoint.sslKeystoreKey

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'

null

false

MEDIUM

camel.sink.endpoint.sslKeystoreLocation

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

null

false

MEDIUM

camel.sink.endpoint.sslKeystorePassword

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.

null

false

MEDIUM

camel.sink.endpoint.sslKeystoreType

The file format of the key store file. This is optional for client.

"JKS"

false

MEDIUM

camel.sink.endpoint.sslProtocol

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'.

"TLSv1.2"

false

MEDIUM

camel.sink.endpoint.sslProvider

The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.

null

false

MEDIUM

camel.sink.endpoint.sslSecureRandomImplementation

The SecureRandom PRNG implementation to use for SSL cryptography operations.

null

false

MEDIUM

camel.sink.endpoint.sslTrustmanagerAlgorithm

The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.

"PKIX"

false

MEDIUM

camel.sink.endpoint.sslTruststoreCertificates

Trusted certificates in the format specified by 'ssl.truststore.type'. Default SSL engine factory supports only PEM format with X.509 certificates.

null

false

MEDIUM

camel.sink.endpoint.sslTruststoreLocation

The location of the trust store file.

null

false

MEDIUM

camel.sink.endpoint.sslTruststorePassword

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.

null

false

MEDIUM

camel.sink.endpoint.sslTruststoreType

The file format of the trust store file.

"JKS"

false

MEDIUM

camel.component.vertx-kafka.additionalProperties

Sets additional properties for either kafka consumer or kafka producer in case they can’t be set directly on the camel configurations (e.g: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro

null

false

MEDIUM

camel.component.vertx-kafka.bootstrapServers

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).

null

false

MEDIUM

camel.component.vertx-kafka.clientDnsLookup

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. If set to default (deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses. One of: [default] [use_all_dns_ips] [resolve_canonical_bootstrap_servers_only]

"use_all_dns_ips"

false

MEDIUM

camel.component.vertx-kafka.clientId

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.

null

false

MEDIUM

camel.component.vertx-kafka.configuration

The component configurations

null

false

MEDIUM

camel.component.vertx-kafka.connectionsMaxIdleMs

Close idle connections after the number of milliseconds specified by this config.

540000L

false

MEDIUM

camel.component.vertx-kafka.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

camel.component.vertx-kafka.interceptorClasses

A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.producer.ProducerInterceptor interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors.

null

false

MEDIUM

camel.component.vertx-kafka.metadataMaxAgeMs

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.

300000L

false

MEDIUM

camel.component.vertx-kafka.metricReporters

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.

null

false

MEDIUM

camel.component.vertx-kafka.metricsNumSamples

The number of samples maintained to compute metrics.

2

false

MEDIUM

camel.component.vertx-kafka.metricsRecordingLevel

The highest recording level for metrics. One of: [INFO] [DEBUG] [TRACE]

"INFO"

false

MEDIUM

camel.component.vertx-kafka.metricsSampleWindowMs

The window of time a metrics sample is computed over.

30000L

false

MEDIUM

camel.component.vertx-kafka.partitionId

The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config

null

false

MEDIUM

camel.component.vertx-kafka.receiveBufferBytes

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.

32768

false

MEDIUM

camel.component.vertx-kafka.reconnectBackoffMaxMs

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.

1000L

false

MEDIUM

camel.component.vertx-kafka.reconnectBackoffMs

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.

50L

false

MEDIUM

camel.component.vertx-kafka.requestTimeoutMs

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. This should be larger than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries.

30000

false

MEDIUM

camel.component.vertx-kafka.retryBackoffMs

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.

100L

false

MEDIUM

camel.component.vertx-kafka.sendBufferBytes

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.

131072

false

MEDIUM

camel.component.vertx-kafka.socketConnectionSetup TimeoutMaxMs

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.

127000L

false

MEDIUM

camel.component.vertx-kafka.socketConnectionSetup TimeoutMs

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.

10000L

false

MEDIUM

camel.component.vertx-kafka.acks

The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed: acks=0 If set to zero then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retries configuration will not take effect (as the client won’t generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee. This is equivalent to the acks=-1 setting. One of: [all] [-1] [0] [1]

"1"

false

MEDIUM

camel.component.vertx-kafka.batchSize

The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size. Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records.

16384

false

MEDIUM

camel.component.vertx-kafka.bufferMemory

The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will block for max.block.ms after which it will throw an exception.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests.

33554432L

false

MEDIUM

camel.component.vertx-kafka.compressionType

The compression type for all data generated by the producer. The default is none (i.e. no compression). Valid values are none, gzip, snappy, lz4, or zstd. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).

"none"

false

MEDIUM

camel.component.vertx-kafka.deliveryTimeoutMs

An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures. The producer may report failure to send a record earlier than this config if either an unrecoverable error is encountered, the retries have been exhausted, or the record is added to a batch which reached an earlier delivery expiration deadline. The value of this config should be greater than or equal to the sum of request.timeout.ms and linger.ms.

120000

false

MEDIUM

camel.component.vertx-kafka.enableIdempotence

When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5, retries to be greater than 0 and acks must be 'all'. If these values are not explicitly set by the user, suitable values will be chosen. If incompatible values are set, a ConfigException will be thrown.

false

false

MEDIUM

camel.component.vertx-kafka.keySerializer

Serializer class for key that implements the org.apache.kafka.common.serialization.Serializer interface.

"org.apache.kafka.common.serialization.StringSerializer"

false

MEDIUM

camel.component.vertx-kafka.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

false

MEDIUM

camel.component.vertx-kafka.lingerMs

The producer groups together any records that arrive in between request transmissions into a single batched request. Normally this occurs only under load when records arrive faster than they can be sent out. However in some circumstances the client may want to reduce the number of requests even under moderate load. This setting accomplishes this by adding a small amount of artificial delay—that is, rather than immediately sending out a record the producer will wait for up to the given delay to allow other records to be sent so that the sends can be batched together. This can be thought of as analogous to Nagle’s algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e. no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absence of load.

0L

false

MEDIUM

camel.component.vertx-kafka.maxBlockMs

The configuration controls how long the KafkaProducer’s send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block. For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout). For partitionsFor() this timeout bounds the time spent waiting for metadata if it is unavailable. The transaction-related methods always block, but may timeout if the transaction coordinator could not be discovered or did not respond within the timeout.

60000L

false

MEDIUM

camel.component.vertx-kafka.maxInFlightRequestsPer Connection

The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled).

5

false

MEDIUM

camel.component.vertx-kafka.maxRequestSize

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. This is also effectively a cap on the maximum uncompressed record batch size. Note that the server has its own cap on the record batch size (after compression if compression is enabled) which may be different from this.

1048576

false

MEDIUM

camel.component.vertx-kafka.metadataMaxIdleMs

Controls how long the producer will cache metadata for a topic that’s idle. If the elapsed time since a topic was last produced to exceeds the metadata idle duration, then the topic’s metadata is forgotten and the next access to it will force a metadata fetch request.

300000L

false

MEDIUM

camel.component.vertx-kafka.partitionerClass

Partitioner class that implements the org.apache.kafka.clients.producer.Partitioner interface.

"org.apache.kafka.clients.producer.internals.DefaultPartitioner"

false

MEDIUM

camel.component.vertx-kafka.retries

Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error. Note that this retry is no different than if the client resent the record upon receiving the error. Allowing retries without setting max.in.flight.requests.per.connection to 1 will potentially change the ordering of records because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds, then the records in the second batch may appear first. Note additionally that produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior.

2147483647

false

MEDIUM

camel.component.vertx-kafka.transactionalId

The TransactionalId to use for transactional delivery. This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions. If no TransactionalId is provided, then the producer is limited to idempotent delivery. If a TransactionalId is configured, enable.idempotence is implied. By default the TransactionId is not configured, which means transactions cannot be used. Note that, by default, transactions require a cluster of at least three brokers which is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor.

null

false

MEDIUM

camel.component.vertx-kafka.transactionTimeoutMs

The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with a InvalidTxnTimeoutException error.

60000

false

MEDIUM

camel.component.vertx-kafka.valueSerializer

Serializer class for value that implements the org.apache.kafka.common.serialization.Serializer interface.

"org.apache.kafka.common.serialization.StringSerializer"

false

MEDIUM

camel.component.vertx-kafka.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

false

MEDIUM

camel.component.vertx-kafka.vertx

To use an existing vertx instead of creating a new instance

null

false

MEDIUM

camel.component.vertx-kafka.vertxKafkaClient Factory

Factory to use for creating io.vertx.kafka.client.consumer.KafkaConsumer and io.vertx.kafka.client.consumer.KafkaProducer instances. This allows to configure a custom factory to create custom KafkaConsumer and KafkaProducer instances with logic that extends the vanilla VertX Kafka clients.

null

false

MEDIUM

camel.component.vertx-kafka.vertxOptions

To provide a custom set of vertx options for configuring vertx

null

false

MEDIUM

camel.component.vertx-kafka.saslClientCallback HandlerClass

The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.

null

false

MEDIUM

camel.component.vertx-kafka.saslJaasConfig

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;

null

false

MEDIUM

camel.component.vertx-kafka.saslKerberosKinitCmd

Kerberos kinit command path.

"/usr/bin/kinit"

false

MEDIUM

camel.component.vertx-kafka.saslKerberosMinTime BeforeRelogin

Login thread sleep time between refresh attempts.

60000L

false

MEDIUM

camel.component.vertx-kafka.saslKerberosService Name

The Kerberos principal name that Kafka runs as. This can be defined either in Kafka’s JAAS config or in Kafka’s config.

null

false

MEDIUM

camel.component.vertx-kafka.saslKerberosTicket RenewJitter

Percentage of random jitter added to the renewal time.

0.05D

false

MEDIUM

camel.component.vertx-kafka.saslKerberosTicket RenewWindowFactor

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.

0.8D

false

MEDIUM

camel.component.vertx-kafka.saslLoginCallback HandlerClass

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

null

false

MEDIUM

camel.component.vertx-kafka.saslLoginClass

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

null

false

MEDIUM

camel.component.vertx-kafka.saslLoginRefreshBuffer 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.

300

false

MEDIUM

camel.component.vertx-kafka.saslLoginRefreshMin PeriodSeconds

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.

60

false

MEDIUM

camel.component.vertx-kafka.saslLoginRefreshWindow 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.

0.8D

false

MEDIUM

camel.component.vertx-kafka.saslLoginRefreshWindow 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.

0.05D

false

MEDIUM

camel.component.vertx-kafka.saslMechanism

SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism.

"GSSAPI"

false

MEDIUM

camel.component.vertx-kafka.securityProtocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

"PLAINTEXT"

false

MEDIUM

camel.component.vertx-kafka.securityProviders

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.

null

false

MEDIUM

camel.component.vertx-kafka.sslCipherSuites

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.

null

false

MEDIUM

camel.component.vertx-kafka.sslEnabledProtocols

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.

"TLSv1.2,TLSv1.3"

false

MEDIUM

camel.component.vertx-kafka.sslEndpoint IdentificationAlgorithm

The endpoint identification algorithm to validate server hostname using server certificate.

"https"

false

MEDIUM

camel.component.vertx-kafka.sslEngineFactoryClass

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

null

false

MEDIUM

camel.component.vertx-kafka.sslKeymanagerAlgorithm

The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.

"SunX509"

false

MEDIUM

camel.component.vertx-kafka.sslKeyPassword

The password of the private key in the key store file orthe PEM key specified in ssl.keystore.key'. This is required for clients only if two-way authentication is configured.

null

false

MEDIUM

camel.component.vertx-kafka.sslKeystoreCertificate 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

null

false

MEDIUM

camel.component.vertx-kafka.sslKeystoreKey

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'

null

false

MEDIUM

camel.component.vertx-kafka.sslKeystoreLocation

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

null

false

MEDIUM

camel.component.vertx-kafka.sslKeystorePassword

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.

null

false

MEDIUM

camel.component.vertx-kafka.sslKeystoreType

The file format of the key store file. This is optional for client.

"JKS"

false

MEDIUM

camel.component.vertx-kafka.sslProtocol

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'.

"TLSv1.2"

false

MEDIUM

camel.component.vertx-kafka.sslProvider

The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.

null

false

MEDIUM

camel.component.vertx-kafka.sslSecureRandom Implementation

The SecureRandom PRNG implementation to use for SSL cryptography operations.

null

false

MEDIUM

camel.component.vertx-kafka.sslTrustmanager 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.

"PKIX"

false

MEDIUM

camel.component.vertx-kafka.sslTruststore Certificates

Trusted certificates in the format specified by 'ssl.truststore.type'. Default SSL engine factory supports only PEM format with X.509 certificates.

null

false

MEDIUM

camel.component.vertx-kafka.sslTruststoreLocation

The location of the trust store file.

null

false

MEDIUM

camel.component.vertx-kafka.sslTruststorePassword

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.

null

false

MEDIUM

camel.component.vertx-kafka.sslTruststoreType

The file format of the trust store file.

"JKS"

false

MEDIUM

The camel-vertx-kafka sink connector has no converters out of the box.

The camel-vertx-kafka sink connector has no transforms out of the box.

The camel-vertx-kafka sink connector has no aggregation strategies out of the box.