Docs Cloud Redpanda Connect Components Inputs kafka_franz kafka_franz Type: InputOutput Available in: Cloud, Self-Managed A Kafka input using the Franz Kafka client library. Common Advanced # Common configuration fields, showing default values input: label: "" kafka_franz: seed_brokers: [] # No default (required) topics: [] # No default (required) regexp_topics: false transaction_isolation_level: read_uncommitted consumer_group: "" # No default (optional) auto_replay_nacks: true # All configuration fields, showing default values input: label: "" kafka_franz: seed_brokers: [] # No default (required) client_id: benthos tls: enabled: false skip_cert_verify: false enable_renegotiation: false root_cas: "" # No default (optional) root_cas_file: "" # No default (optional) client_certs: [] # No default (optional) sasl: [] # No default (optional) metadata_max_age: 5m request_timeout_overhead: 10s conn_idle_timeout: 20s topics: [] # No default (required) regexp_topics: false rack_id: "" # No default (optional) instance_id: "" # No default (optional) rebalance_timeout: 45s session_timeout: 1m heartbeat_interval: 3s start_offset: earliest fetch_max_bytes: 50MiB fetch_max_wait: 5s fetch_min_bytes: 1B fetch_max_partition_bytes: 1MiB transaction_isolation_level: read_uncommitted consumer_group: "" # No default (optional) checkpoint_limit: 1024 commit_period: 5s multi_header: false batching: count: 0 byte_size: 0 period: "" # No default (optional) check: "" # No default (optional) processors: [] # No default (optional) topic_lag_refresh_period: 5s auto_replay_nacks: true When you specify a consumer group in your configuration, this input consumes one or more topics and automatically balances the topic partitions across any other connected clients with the same consumer group. Otherwise, topics are consumed in their entirety or with explicit partitions. This input often out-performs the traditional kafka input and provides more useful logs and error messages. Metadata This input adds the following metadata fields to each message: - kafka_key - kafka_topic - kafka_partition - kafka_offset - kafka_timestamp_ms - kafka_timestamp_unix - kafka_tombstone_message - All record headers Fields auto_replay_nacks Whether to automatically replay rejected messages (negative acknowledgements) at the output level. If the cause of rejections persists, leaving this option enabled can result in back pressure. Set auto_replay_nacks to false to delete rejected messages. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data is discarded immediately upon consumption and mutation. Type: bool Default: true batching Configure a batching policy that applies to individual topic partitions in order to batch messages together before flushing them for processing. Batching can be beneficial for performance as well as useful for windowed processing, and doing so this way preserves the ordering of topic partitions. Type: object # Examples: batching: byte_size: 5000 count: 0 period: 1s batching: count: 10 period: 1s batching: check: this.contains("END BATCH") count: 0 period: 1m batching.byte_size The number of bytes at which the batch is flushed. Set to 0 to disable size-based batching. Type: int Default: 0 batching.check A Bloblang query that should return a boolean value indicating whether a message should end a batch. Type: string Default: "" # Examples: check: this.type == "end_of_transaction" batching.count The number of messages after which the batch is flushed. Set to 0 to disable count-based batching. Type: int Default: 0 batching.period The period after which an incomplete batch is flushed regardless of its size. Type: string Default: "" # Examples: period: 1s period: 1m period: 500ms batching.processors[] For aggregating and archiving message batches, you can add a list of processors to apply to a batch as it is flushed. All resulting messages are flushed as a single batch even when you configure processors to split the batch into smaller batches. Type: processor # Examples: processors: - archive: format: concatenate - archive: format: lines - archive: format: json_array checkpoint_limit The maximum number of messages that are processed in parallel inside the same partition before back pressure is applied. When a message with a specific offset is delivered to the output, the offset is only committed when all messages of previous offsets have also been delivered. This behavior ensures at-least-once delivery guarantees. However, in the event of crashes or server faults, it also increases the likelihood of duplicates. To decrease this risk, reduce the checkpoint_limit value. Type: int Default: 1024 client_id An identifier for the client connection. Type: string Default: benthos commit_period The period of time between each commit of the current partition offsets. Offsets are always committed during shutdown. Type: string Default: 5s conn_idle_timeout Define how long connections can remain idle before they are closed. Type: string Default: 20s consumer_group An optional consumer group. When you specify this value: The partitions of any topics, specified in the topics field, are automatically distributed across consumers sharing a consumer group Partition offsets are automatically committed and resumed under this name Consumer groups are not supported when you specify explicit partitions to consume from in the topics field. Type: string fetch_max_bytes The maximum size of a message batch (in bytes) that a broker tries to send during a client fetch. If individual records exceed the fetch_max_bytes value, brokers will still send them. Type: string Default: 50MiB fetch_max_partition_bytes The maximum number of bytes that are consumed from a single partition in a fetch request. This field is equivalent to the Java setting fetch.max.partition.bytes. If a single batch is larger than the fetch_max_partition_bytes value, the batch is still sent so that the client can make progress. Type: string Default: 1MiB fetch_max_wait The maximum period of time a broker can wait for a fetch response to reach the required minimum number of bytes (fetch_min_bytes). Type: string Default: 5s fetch_min_bytes The minimum number of bytes that a broker tries to send during a fetch. This field is equivalent to the Java setting fetch.min.bytes. Type: string Default: 1B heartbeat_interval When you specify a consumer_group, heartbeat_interval sets how frequently a consumer group member should send heartbeats to Apache Kafka. Apache Kafka uses heartbeats to make sure that a group member’s session is active. You must set heartbeat_interval to less than one-third of session_timeout. This field is equivalent to the Java heartbeat.interval.ms setting. client Type: string Default: 3s instance_id When you specify a consumer_group, assign a unique value to instance_id to define the group’s static membership, which can prevent unnecessary rebalances during reconnections. When you assign an instance ID, the client does not automatically leave the consumer group when it disconnects. To remove the client, you must use an external admin command on behalf of the instance ID. Type: string Default: "" metadata_max_age The maximum period of time after which metadata is refreshed. Type: string Default: 5m multi_header Decode headers into lists to allow the handling of multiple values with the same key. Type: bool Default: false rack_id A rack specifies where the client is physically located, and changes fetch requests to consume from the closest replica as opposed to the leader replica. Type: string Default: "" rebalance_timeout When you specify a consumer_group, rebalance_timeout sets a time limit for all consumer group members to complete their work and commit offsets after a rebalance has begun. The timeout excludes the time taken to detect a failed or late heartbeat, which indicates a rebalance is required. Type: string Default: 45s regexp_topics Whether listed topics should be interpreted as regular expression patterns for matching multiple topics. When topics are specified with explicit partitions this field must remain set to false. Type: bool Default: false request_timeout_overhead Grants an additional buffer or overhead to requests that have timeout fields defined. This field is based on the behavior of Apache Kafka’s request.timeout.ms parameter. Type: string Default: 10s sasl[] Specify one or more methods or mechanisms of SASL authentication, which are attempted in order. If the broker supports the first SASL mechanism, all connections use it. If the first mechanism fails, the client picks the first supported mechanism. If the broker does not support any client mechanisms, all connections fail. Type: object # Examples: sasl: - mechanism: SCRAM-SHA-512 password: bar username: foo sasl[].aws Contains AWS specific fields for when the mechanism is set to AWS_MSK_IAM. Type: object sasl[].aws.credentials Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services. Type: object sasl[].aws.credentials.from_ec2_role Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance. Type: bool sasl[].aws.credentials.id The ID of credentials to use. Type: string sasl[].aws.credentials.profile A profile from ~/.aws/credentials to use. Type: string sasl[].aws.credentials.role A role ARN to assume. Type: string sasl[].aws.credentials.role_external_id An external ID to provide when assuming a role. Type: string sasl[].aws.credentials.secret The secret for the credentials being used. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string sasl[].aws.credentials.token The token for the credentials being used, required when using short term credentials. Type: string sasl[].aws.endpoint Allows you to specify a custom endpoint for the AWS API. Type: string sasl[].aws.region The AWS region to target. Type: string sasl[].extensions Key/value pairs to add to OAUTHBEARER authentication requests. Type: string sasl[].mechanism The SASL mechanism to use. Type: string Option Summary AWS_MSK_IAM AWS IAM based authentication as specified by the 'aws-msk-iam-auth' java library. OAUTHBEARER OAuth Bearer based authentication. PLAIN Plain text authentication. SCRAM-SHA-256 SCRAM based authentication as specified in RFC5802. SCRAM-SHA-512 SCRAM based authentication as specified in RFC5802. none Disable sasl authentication sasl[].password A password to provide for PLAIN or SCRAM-* authentication. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" sasl[].token The token to use for a single session’s OAUTHBEARER authentication. Type: string Default: "" sasl[].username A username to provide for PLAIN or SCRAM-* authentication. Type: string Default: "" seed_brokers[] A list of broker addresses to connect to in order. Use commas to separate multiple addresses in a single list item. Type: array # Examples: seed_brokers: - "localhost:9092" - "foo:9092" - "bar:9092" - "foo:9092,bar:9092" session_timeout When you specify a consumer_group, session_timeout sets the maximum interval between heartbeats sent by a consumer group member to the broker. If a broker doesn’t receive a heartbeat from a group member before the timeout expires, it removes the member from the consumer group and initiates a rebalance. broker Type: string Default: 1m start_offset Specify the offset from which this input starts or restarts consuming messages. Restarts occur when the OffsetOutOfRange error is seen during a fetch. Type: string Default: earliest Option Summary committed Prevents consuming a partition in a group if the partition has no prior commits. Corresponds to Kafka’s auto.offset.reset=none option earliest Start from the earliest offset. Corresponds to Kafka’s auto.offset.reset=earliest option. latest Start from the latest offset. Corresponds to Kafka’s auto.offset.reset=latest option. tls Override system defaults with custom TLS settings. Type: object tls.client_certs[] A list of client certificates to use. For each certificate, specify values for either the cert and key fields, or cert_file and key_file fields. Type: object Default: [] # Examples: client_certs: - cert: foo key: bar - cert_file: ./example.pem key_file: ./example.key tls.client_certs[].cert A plain text certificate to use. Type: string Default: "" tls.client_certs[].cert_file The path of a certificate to use. Type: string Default: "" tls.client_certs[].key A plain text certificate key to use. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" tls.client_certs[].key_file The path of a certificate key to use. Type: string Default: "" tls.client_certs[].password A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" # Examples: password: foo password: ${KEY_PASSWORD} tls.enable_renegotiation Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation. Type: bool Default: false tls.enabled Whether custom TLS settings are enabled. Type: bool Default: false tls.root_cas Specify a root certificate authority to use (optional). This is a string, representing a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" # Examples: root_cas: |- -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- tls.root_cas_file Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Type: string Default: "" # Examples: root_cas_file: ./root_cas.pem tls.skip_cert_verify Whether to skip server-side certificate verification. Type: bool Default: false topic_lag_refresh_period The interval between refresh cycles. During each cycle, this input queries the Redpanda Connect server to calculate the topic lag - the number of produced messages that remain to be read from each topic/partition pair by the specified consumer group. Type: string Default: 5s topics[] A list of topics to consume from. Use commas to separate multiple topics in a single element. When a consumer_group is specified, partitions are automatically distributed across consumers of a topic. Otherwise, all partitions are consumed. Alternatively, you can specify explicit partitions to consume by using a colon after the topic name. For example, foo:0 would consume the partition 0 of the topic foo. This syntax supports ranges. For example, foo:0-10 would consume partitions 0 through to 10 inclusive. It is also possible to specify an explicit offset to consume from by adding another colon after the partition. For example, foo:0:10 would consume the partition 0 of the topic foo starting from the offset 10. If the offset is not present (or remains unspecified) then the field start_offset determines which offset to start from. Type: array # Examples: topics: - foo - bar - things.* - "foo,bar" - "foo:0" - "bar:1" - "bar:3" - "foo:0,bar:1,bar:3" - "foo:0-5" transaction_isolation_level Defines how transactional messages are handled. Type: string Default: read_uncommitted Option Summary read_committed If set, only committed transactional records are processed. read_uncommitted If set, then uncommitted records are processed. Back to top × Simple online edits For simple changes, such as fixing a typo, you can edit the content directly on GitHub. Edit on GitHub Or, open an issue to let us know about something that you want us to change. Open an issue Contribution guide For extensive content updates, or if you prefer to work locally, read our contribution guide . Was this helpful? thumb_up thumb_down group Ask in the community mail Share your feedback group_add Make a contribution 🎉 Thanks for your feedback! kafka mongodb_cdc