Kafka Sink Connector Configuration Reference for Confluent Platform¶
This topic includes Kafka Connect sink connector configuration properties available for Confluent Platform. The parameters are organized by order of importance, ranked from high to low.
Search by configuration property name¶
Enter a string to search and filter by configuration property name.
name¶
Globally unique name to use for this connector.
| Type: | string |
| Default: | |
| Valid Values: | non-empty string without ISO control characters |
| Importance: | high |
connector.class¶
Name or alias of the class for this connector. Must be a subclass of org.apache.kafka.connect.connector.Connector. If the connector is org.apache.kafka.connect.file.FileStreamSinkConnector, you can either specify this full name, or use “FileStreamSink” or “FileStreamSinkConnector” to make the configuration a bit shorter
| Type: | string |
| Default: | |
| Valid Values: | |
| Importance: | high |
tasks.max¶
Maximum number of tasks to use for this connector.
| Type: | int |
| Default: | 1 |
| Valid Values: | [1,…] |
| Importance: | high |
topics¶
List of topics to consume, separated by commas
| Type: | list |
| Default: | “” |
| Valid Values: | |
| Importance: | high |
topics.regex¶
Regular expression giving topics to consume. Under the hood, the regex is compiled to a java.util.regex.Pattern. Only one of topics or topics.regex should be specified.
| Type: | string |
| Default: | “” |
| Valid Values: | valid regex |
| Importance: | high |
tasks.max.enforce¶
(Deprecated) Whether to enforce that the tasks.max property is respected by the connector. By default, connectors that generate too many tasks will fail, and existing sets of tasks that exceed the tasks.max property will also be failed. If this property is set to false, then connectors will be allowed to generate more than the maximum number of tasks, and existing sets of tasks that exceed the tasks.max property will be allowed to run. This property is deprecated and will be removed in an upcoming major release.
| Type: | boolean |
| Default: | true |
| Valid Values: | |
| Importance: | low |
key.converter¶
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.
| Type: | class |
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.Converter, A class with a public, no-argument constructor |
| Importance: | low |
value.converter¶
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.
| Type: | class |
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.Converter, A class with a public, no-argument constructor |
| Importance: | low |
header.converter¶
HeaderConverter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the header values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. By default, the SimpleHeaderConverter is used to serialize header values to strings and deserialize them by inferring the schemas.
| Type: | class |
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.HeaderConverter, A class with a public, no-argument constructor |
| Importance: | low |
config.action.reload¶
The action that Connect should take on the connector when changes in external configuration providers result in a change in the connector’s configuration properties. A value of ‘none’ indicates that Connect will do nothing. A value of ‘restart’ indicates that Connect should restart/reload the connector with the updated configuration properties.The restart may actually be scheduled in the future if the external configuration provider indicates that a configuration value will expire in the future.
| Type: | string |
| Default: | restart |
| Valid Values: | [none, restart] |
| Importance: | low |
transforms¶
Aliases for the transformations to be applied to records.
| Type: | list |
| Default: | “” |
| Valid Values: | non-null string, unique transformation aliases |
| Importance: | low |
predicates¶
Aliases for the predicates used by transformations.
| Type: | list |
| Default: | “” |
| Valid Values: | non-null string, unique predicate aliases |
| Importance: | low |
errors.retry.timeout¶
The maximum duration in milliseconds that a failed operation will be reattempted. The default is 0, which means no retries will be attempted. Use -1 for infinite retries.
| Type: | long |
| Default: | 0 |
| Valid Values: | |
| Importance: | medium |
errors.retry.delay.max.ms¶
The maximum duration in milliseconds between consecutive retry attempts. Jitter will be added to the delay once this limit is reached to prevent thundering herd issues.
| Type: | long |
| Default: | 60000 (1 minute) |
| Valid Values: | |
| Importance: | medium |
errors.tolerance¶
Behavior for tolerating errors during connector operation. ‘none’ is the default value and signals that any error will result in an immediate connector task failure; ‘all’ changes the behavior to skip over problematic records.
| Type: | string |
| Default: | none |
| Valid Values: | [none, all] |
| Importance: | medium |
errors.log.enable¶
If true, write each error and the details of the failed operation and problematic record to the Connect application log. This is ‘false’ by default, so that only errors that are not tolerated are reported.
| Type: | boolean |
| Default: | false |
| Valid Values: | |
| Importance: | medium |
errors.log.include.messages¶
Whether to include in the log the Connect record that resulted in a failure. For sink records, the topic, partition, offset, and timestamp will be logged. For source records, the key and value (and their schemas), all headers, and the timestamp, Kafka topic, Kafka partition, source partition, and source offset will be logged. This is ‘false’ by default, which will prevent record keys, values, and headers from being written to log files.
| Type: | boolean |
| Default: | false |
| Valid Values: | |
| Importance: | medium |
errors.deadletterqueue.topic.name¶
The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. The topic name is blank by default, which means that no messages are to be recorded in the DLQ.
| Type: | string |
| Default: | “” |
| Valid Values: | |
| Importance: | medium |
errors.deadletterqueue.topic.replication.factor¶
Replication factor used to create the dead letter queue topic when it doesn’t already exist.
| Type: | short |
| Default: | 3 |
| Valid Values: | |
| Importance: | medium |
errors.deadletterqueue.context.headers.enable¶
If true, add headers containing error context to the messages written to the dead letter queue. To avoid clashing with headers from the original record, all error context header keys, all error context header keys will start with __connect.errors.
| Type: | boolean |
| Default: | false |
| Valid Values: | |
| Importance: | medium |
Note
This website includes content developed at the Apache Software Foundation under the terms of the Apache License v2.