redpanda

Beta

Type:

Available in: Cloud, Self-Managed

Sends message data to Kafka brokers and waits for acknowledgement before propagating any acknowledgements back to the input.

Common
Advanced

# Common configuration fields, showing default values
output:
  label: ""
  redpanda:
    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: 256

# All configuration fields, showing default values
output:
  label: ""
  redpanda:
    seed_brokers: [] # No default (required)
    client_id: benthos
    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
    topic: "" # No default (required)
    key: "" # No default (optional)
    partition: ${! meta("partition") } # No default (optional)
    metadata:
      include_prefixes: []
      include_patterns: []
    timestamp_ms: ${! timestamp_unix_milli() } # No default (optional)
    max_in_flight: 256
    partitioner: "" # No default (optional)
    idempotent_write: true
    compression: "" # No default (optional)
    timeout: 10s
    max_message_bytes: 1MB
    broker_write_max_bytes: 100MB

Fields

`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

seed_brokers:
  - foo:9092
  - bar:9092

seed_brokers:
  - foo:9092,bar:9092

`client_id`

An identifier for the client connection.

Type: string

Default: benthos

`tls`

Override system defaults with custom TLS settings.

Type: object

`tls.enabled`

Whether custom TLS settings are enabled.

Type: bool

Default: false

`tls.skip_cert_verify`

Whether to skip server-side certificate verification.

Type: bool

Default: false

`tls.enable_renegotiation`

Whether to allow the remote server to request renegotiation. Enable this option if you’re seeing the error message Enable this option if you’re seeing the error message local error: tls: no renegotiation.

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.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: array

Default: []

# Examples

client_certs:
  - cert: foo
    key: bar

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

`tls.client_certs[].cert`

The plain text certificate to use.

Type: string

Default: ""

`tls.client_certs[].key`

The 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[].cert_file`

The path to the certificate to use.

Type: string

Default: ""

`tls.client_certs[].key_file`

The path of a certificate key to use.

Type: string

Default: ""

`tls.client_certs[].password`

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

The pbeWithMD5AndDES-CBC algorithm does not authenticate ciphertext, and is vulnerable to padding Oracle attacks that may allow an attacker recover the plain text password.

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}

`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: array

# Examples

sasl:
  - mechanism: SCRAM-SHA-512
    password: bar
    username: foo

`sasl[].mechanism`

The SASL mechanism to use.

Type: string

Option Summary

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 RFC 5802
`SCRAM-SHA-512`	SCRAM-based authentication as specified in RFC 5802
`none`	Disable SASL authentication

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 RFC 5802

SCRAM-SHA-512

SCRAM-based authentication as specified in RFC 5802

none

Disable SASL authentication

`sasl[].username`

A username for PLAIN or SCRAM-* authentication.

Type: string

Default: ""

`sasl[].password`

A password 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[].extensions`

Key/value pairs to add to OAUTHBEARER authentication requests.

Type: object

`sasl[].aws`

AWS specific fields for when the mechanism is set to AWS_MSK_IAM.

Type: object

`sasl[].aws.region`

The AWS region to target.

Type: string

Default: ""

`sasl[].aws.endpoint`

Specify a custom endpoint for the AWS API.

Type: string

Default: ""

`sasl[].aws.credentials`

Manually configure the AWS credentials to use (optional). For more information, see the Amazon Web Services guide.

Type: object

`sasl[].aws.credentials.profile`

The profile from ~/.aws/credentials to use.

Type: string

Default: ""

`sasl[].aws.credentials.id`

The ID of the AWS credentials to use.

Type: string

Default: ""

`sasl[].aws.credentials.secret`

The secret for the AWS credentials in 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: ""

`sasl[].aws.credentials.token`

The token for the AWS credentials in use. This is a required value for short-term credentials.

Type: string

Default: ""

`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

Default: false

`sasl[].aws.credentials.role`

The role ARN to assume.

Type: string

Default: ""

`sasl[].aws.credentials.role_external_id`

An external ID to use when assuming a role.

Type: string

Default: ""

`metadata_max_age`

The maximum period of time after which metadata is refreshed.

Type: string

Default: 5m

`topic`

A topic to write messages to. This field supports interpolation functions.

Type: string

`key`

An optional key to populate for each message. This field supports interpolation functions.

Type: string

`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") }

`metadata`

Specify which (if any) metadata values are added to messages as headers.

Type: object

`metadata.include_prefixes`

Provide a list of explicit metadata key prefixes to match against.

Type: array

Default: []

# Examples

include_prefixes:
  - foo_
  - bar_

include_prefixes:
  - kafka_

include_prefixes:
  - content-

`metadata.include_patterns`

Provide a list of explicit metadata key regular expression (re2) patterns to match against.

Type: array

Default: []

# Examples

include_patterns:
  - .*

include_patterns:
  - _timestamp_unix$

`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") }

`max_in_flight`

The maximum number of messages to have in flight at a given time. Increase this number to improve throughput until performance plateaus.

Type: int

Default: 256

`partitioner`

Override the default murmur2 hashing partitioner.

Type: string

Option Summary

Option	Summary
`least_backup`	Chooses the least backed up partition. The partition with the fewest buffered records. Partitions are selected per batch.
`manual`	Manually select a partition for each message. You must also specify a value for the `partition` field.
`murmur2_hash`	Kafka’s default hash algorithm that uses a 32-bit murmur2 hash of the key to compute the partition for the record.
`round_robin`	Does a round robin of messages through all available partitions. This algorithm has lower throughput and causes higher CPU load on brokers, but is useful if you want to ensure an even distribution of records to partitions.

least_backup

Chooses the least backed up partition. The partition with the fewest buffered records. Partitions are selected per batch.

manual

Manually select a partition for each message. You must also specify a value for the partition field.

murmur2_hash

Kafka’s default hash algorithm that uses a 32-bit murmur2 hash of the key to compute the partition for the record.

round_robin

Does a round robin of messages through all available partitions. This algorithm has lower throughput and causes higher CPU load on brokers, but is useful if you want to ensure an even distribution of records to partitions.

`idempotent_write`

Enable the idempotent write producer option. This requires the IDEMPOTENT_WRITE permission on CLUSTER. Disable this option if the IDEMPOTENT_WRITE permission is not available.

Type: bool

Default: true

`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

`timeout`

The maximum period of time to wait for message sends before abandoning the request and retrying.

Type: string

Default: 10s

`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: 1MB

# Examples

max_message_bytes: 100MB

max_message_bytes: 50mib

`broker_write_max_bytes`

The upper bound for the number of bytes written to a broker connection in a single write. This field corresponds to Kafka’s socket.request.max.bytes.

Type: string

Default: 100MB

# Examples

broker_write_max_bytes: 128MB

broker_write_max_bytes: 50mib

Was this helpful?

group Ask in the community

mail Share your feedback

group_add Make a contribution

What do you like about this doc?

Let us know what we do well:

Let us contact you about your feedback:

What did you not like about this doc?

Let us know what we can improve:

Let us contact you about your feedback:

redpanda

Fields

seed_brokers

client_id

tls

tls.enabled

tls.skip_cert_verify

tls.enable_renegotiation

tls.root_cas

tls.root_cas_file

tls.client_certs

tls.client_certs[].cert

tls.client_certs[].key

tls.client_certs[].cert_file

tls.client_certs[].key_file

tls.client_certs[].password

sasl

sasl[].mechanism

sasl[].username

sasl[].password

sasl[].token

sasl[].extensions

sasl[].aws

sasl[].aws.region

sasl[].aws.endpoint

sasl[].aws.credentials

sasl[].aws.credentials.profile

sasl[].aws.credentials.id

sasl[].aws.credentials.secret

sasl[].aws.credentials.token

sasl[].aws.credentials.from_ec2_role

sasl[].aws.credentials.role

sasl[].aws.credentials.role_external_id

metadata_max_age

topic

key

partition

metadata

metadata.include_prefixes

metadata.include_patterns

timestamp_ms

max_in_flight

partitioner

idempotent_write

compression

timeout

max_message_bytes

broker_write_max_bytes

Simple online edits

Contribution guide

`seed_brokers`

`client_id`

`tls`

`tls.enabled`

`tls.skip_cert_verify`

`tls.enable_renegotiation`

`tls.root_cas`

`tls.root_cas_file`

`tls.client_certs`

`tls.client_certs[].cert`

`tls.client_certs[].key`

`tls.client_certs[].cert_file`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`sasl`

`sasl[].mechanism`

`sasl[].username`

`sasl[].password`

`sasl[].token`

`sasl[].extensions`

`sasl[].aws`

`sasl[].aws.region`

`sasl[].aws.endpoint`

`sasl[].aws.credentials`

`sasl[].aws.credentials.profile`

`sasl[].aws.credentials.id`

`sasl[].aws.credentials.secret`

`sasl[].aws.credentials.token`

`sasl[].aws.credentials.from_ec2_role`

`sasl[].aws.credentials.role`

`sasl[].aws.credentials.role_external_id`

`metadata_max_age`

`topic`

`key`

`partition`

`metadata`

`metadata.include_prefixes`

`metadata.include_patterns`

`timestamp_ms`

`max_in_flight`

`partitioner`

`idempotent_write`

`compression`

`timeout`

`max_message_bytes`

`broker_write_max_bytes`