Docs Cloud Redpanda Connect Components Outputs kafka_franz kafka_franz Type: OutputInput Available in: Cloud, Self-Managed The kafka_franz output writes a batch of messages to Kafka brokers and waits for acknowledgement before propagating any acknowledgments back to the input. This output often outperforms the traditional kafka output, as well as providing more useful logs and error messages. This output uses the Franz Kafka client library. Common Advanced # Common configuration fields, showing default values output: label: "" kafka_franz: seed_brokers: [] # No default (required) topic: "" # No default (required) key: "" # No default (optional) partition: ${! meta("partition") } # No default (optional) metadata: include_prefixes: [] include_patterns: [] max_in_flight: 10 batching: count: 0 byte_size: 0 period: "" check: "" # All configuration fields, showing default values output: label: "" kafka_franz: seed_brokers: [] # No default (required) topic: "" # No default (required) key: "" # No default (optional) partitioner: "" # No default (optional) partition: ${! meta("partition") } # No default (optional) client_id: benthos idempotent_write: true metadata: include_prefixes: [] include_patterns: [] max_in_flight: 10 timeout: 10s batching: count: 0 byte_size: 0 period: "" check: "" processors: [] # No default (optional) max_message_bytes: 1MiB broker_write_max_bytes: 100MiB compression: "" # No default (optional) tls: enabled: false skip_cert_verify: false enable_renegotiation: false root_cas: "" root_cas_file: "" client_certs: [] sasl: [] # No default (optional) metadata_max_age: 5m request_timeout_overhead: 10s conn_idle_timeout: 20s timestamp_ms: ${! timestamp_unix_milli() } # No default (optional) Fields allow_auto_topic_creation Enables topics to be auto created if they do not exist when fetching their metadata. Type: bool Default: true batching Allows you to configure a batching policy. 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 broker_write_max_bytes The maximum number of bytes this output can write to a broker connection in a single write. This field corresponds to Kafka’s socket.request.max.bytes. Type: string Default: 100MiB # Examples: broker_write_max_bytes: 128MB broker_write_max_bytes: 50mib client_id An identifier for the client connection. Type: string Default: benthos compression Set an explicit compression type (optional). The default preference is to use snappy when the broker supports it. Otherwise, use none. Type: string Options: lz4, snappy, gzip, none, zstd conn_idle_timeout Define how long connections can remain idle before they are closed. Type: string Default: 20s idempotent_write Enables the idempotent write producer option. This requires the IDEMPOTENT_WRITE permission on CLUSTER. Disable this option if the IDEMPOTENT_WRITE permission is unavailable. Type: bool Default: true key An optional key to populate for each message. This field supports interpolation functions. Type: string max_in_flight The maximum number of batches to send in parallel at any given time. Type: int Default: 10 max_message_bytes The maximum space (in bytes) that an individual message may use. Messages larger than this value are rejected. This field corresponds to Kafka’s max.message.bytes. Type: string Default: 1MiB # Examples: max_message_bytes: 100MB max_message_bytes: 50mib metadata Specify which (if any) metadata values are added to messages as headers. Type: object metadata.include_patterns[] Provide a list of explicit metadata key regular expression (re2) patterns to match against. Type: array Default: [] # Examples: include_patterns: - .* - _timestamp_unix$ metadata.include_prefixes[] Provide a list of explicit metadata key prefixes to match against. Type: array Default: [] # Examples: include_prefixes: - foo_ - bar_ - kafka_ - content- metadata_max_age The maximum period of time after which metadata is refreshed. Type: string Default: 5m partition Set a partition for each message (optional). This field is only relevant when the partitioner is set to manual. This field supports interpolation functions. You must provide an interpolation string that is a valid integer. Type: string # Examples: partition: ${! meta("partition") } partitioner Override the default murmur2 hashing partitioner. Type: string Option Summary least_backup Chooses the least backed up partition (the partition with the fewest amount of buffered records). Partitions are selected per batch. manual Manually select a partition for each message, requires the field partition to be specified. murmur2_hash Kafka’s default hash algorithm that uses a 32-bit murmur2 hash of the key to compute which partition the record will be on. round_robin Round-robin’s messages through all available partitions. This algorithm has lower throughput and causes higher CPU load on brokers, but can be useful if you want to ensure an even distribution of records to partitions. 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, but with the option to extend the timeout deadline. 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" timeout The maximum period of time to wait for message sends before abandoning the request and retrying. Type: string Default: 10s timestamp_ms Set a timestamp (in milliseconds) for each message (optional). When left empty, the current timestamp is used. This field supports interpolation functions. Type: string # Examples: timestamp_ms: ${! timestamp_unix_milli() } timestamp_ms: ${! metadata("kafka_timestamp_ms") } 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 certificate authority to use (optional). This is a string that represents 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 A topic to write messages to. This field supports interpolation functions. Type: string 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