redpanda

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

This output sends messages to Redpanda or any Kafka-compatible broker over the Kafka protocol, waiting for the configured acknowledgements before confirming delivery back to the input. It supports batching, configurable partitioning, idempotent writes, and SASL and TLS authentication. When configuring multiple Redpanda components that share the same credentials, consider using the redpanda_common alternatives instead.

# Config fields, showing default values
output:
  label: ""
  redpanda:
    seed_brokers: []
    topic: "" # No default (required)
    key: ""
    partition: ""
    metadata:
      include_prefixes: []
      include_patterns: []
    max_in_flight: 256
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
      processors: []
    client_id: redpanda-connect
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    sasl: []
    metadata_max_age: 1m
    request_timeout_overhead: 10s
    conn_idle_timeout: 20s
    tcp:
      connect_timeout: 0s
      keep_alive:
        idle: 15s
        interval: 15s
        count: 9
      tcp_user_timeout: 0s
    timestamp: ""
    timestamp_ms: ""
    inject_tracing_map: ""
    partitioner: ""
    idempotent_write: true
    acks: all
    compression: ""
    allow_auto_topic_creation: true
    timeout: 10s
    max_message_bytes: 1MiB
    broker_write_max_bytes: 100MiB
    max_buffered_records: 10000
    max_buffered_bytes: 0
    max_in_flight_requests: 1
    record_retries: 0
    record_delivery_timeout: 0s

Examples

Send to a topic
Authenticated cluster

Write every message to a single topic on a local broker.

output:
  redpanda:
    seed_brokers:
      - localhost:9092
    topic: my-topic

Write to a topic on a multi-broker cluster using SASL and TLS, flushing in batches.

output:
  redpanda:
    seed_brokers:
      - broker-1:9092
      - broker-2:9092
    topic: events
    tls:
      enabled: true
    sasl:
      - mechanism: SCRAM-SHA-512
        username: user
        password: "${SASL_PASSWORD}"
    batching:
      count: 100
      period: 1s

Fields

`seed_brokers`

A list of broker addresses to connect to in order to establish connections. If an item of the list contains commas it will be expanded into multiple addresses.

Type: array

# Examples

seed_brokers:
  - localhost:9092

seed_brokers:
  - foo:9092
  - bar:9092

seed_brokers:
  - foo:9092,bar:9092

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

An optional explicit partition to set for each message. This field is only relevant when the partitioner is set to manual. The provided interpolation string must be a valid integer. This field supports interpolation functions.

Type: string

# Examples

partition: ${! meta("partition") }

`metadata`

Determine which (if any) metadata values should be 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$

`max_in_flight`

The maximum number of batches to be sending in parallel at any given time.

Type: int
Default: 256

`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.count`

A number of messages at which the batch should be flushed. If 0 disables count based batching.

Type: int
Default: 0

`batching.byte_size`

An amount of bytes at which the batch should be flushed. If 0 disables size based batching.

Type: int
Default: 0

`batching.period`

A period in which an incomplete batch should be flushed regardless of its size.

Type: string
Default: ""

# Examples

period: 1s

period: 1m

period: 500ms

`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.processors`

A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.

Type: array

# Examples

processors:
  - archive:
      format: concatenate

processors:
  - archive:
      format: lines

processors:
  - archive:
      format: json_array

`client_id`

An identifier for the client connection.

Type: string
Default: "redpanda-connect"

`tls`

Custom TLS settings can be used to override system defaults.

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 repeatedly request renegotiation. Enable this option if you're seeing the error message local error: tls: no renegotiation.

Type: bool
Default: false

`tls.root_cas`

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

# Examples

root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

`tls.root_cas_file`

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to 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 either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array
Default: []

# Examples

client_certs:
  - cert: foo
    key: bar

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

`tls.client_certs[].cert`

A plain text certificate to use.

Type: string
Default: ""

`tls.client_certs[].key`

A plain text certificate key to use. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

`tls.client_certs[].cert_file`

The path of a 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`

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. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

# Examples

password: foo

password: ${KEY_PASSWORD}

`sasl`

Specify one or more methods of SASL authentication. SASL is tried in order; if the broker supports the first mechanism, all connections will use that mechanism. If the first mechanism fails, the client will pick the first supported mechanism. If the broker does not support any client mechanisms, connections will fail.

Type: array

# Examples

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

`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.
`REDPANDA_CLOUD_SERVICE_ACCOUNT`	Authenticate using a Redpanda Cloud service account.
`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[].username`

A username to provide for PLAIN or SCRAM-* authentication.

Type: string
Default: ""

`sasl[].password`

A password to provide for PLAIN or SCRAM-* authentication. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

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`

Contains 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`

Allows you to specify a custom endpoint for the AWS API.

Type: string
Default: ""

`sasl[].aws.credentials`

Optional manual configuration of AWS credentials to use. More information can be found in this document.

Type: object

`sasl[].aws.credentials.profile`

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

Type: string
Default: ""

`sasl[].aws.credentials.id`

The ID of credentials to use.

Type: string
Default: ""

`sasl[].aws.credentials.secret`

The secret for the credentials being used. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

`sasl[].aws.credentials.token`

The token for the credentials being used, required when using 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`

A role ARN to assume.

Type: string
Default: ""

`sasl[].aws.credentials.role_external_id`

An external ID to provide when assuming a role.

Type: string
Default: ""

`sasl[].aws.tcp`

Options for the underlying TCP connection used when authenticating with AWS.

Type: object

`sasl[].aws.tcp.connect_timeout`

The maximum amount of time a dial will wait for a connect to complete. A value of zero disables the timeout.

Type: string
Default: "0s"

`sasl[].aws.tcp.keep_alive.count`

The maximum number of keep-alive probes that can go unanswered before dropping a connection. A value of zero defaults to 9.

Type: int
Default: 9

`sasl[].aws.tcp.keep_alive.idle`

The time that a connection must remain idle before the first keep-alive probe is sent. A value of zero defaults to 15s; a negative value disables keep-alive probes.

Type: string
Default: "15s"

`sasl[].aws.tcp.keep_alive.interval`

The time between keep-alive probes. A value of zero defaults to 15s.

Type: string
Default: "15s"

`sasl[].aws.tcp.tcp_user_timeout`

The maximum amount of time transmitted data may remain unacknowledged before a connection is forcibly closed. This option is only supported on Linux (kernel 2.6.37 and above). A value of zero disables the timeout.

Type: string
Default: "0s"

`metadata_max_age`

This sets the maximum age for the client's cached metadata, to allow detection of new topics, partitions, etc.

Type: string
Default: "1m"

`request_timeout_overhead`

An additional amount of time added as overhead to requests that contain a timeout field, based on Kafka's request.timeout.ms.

Type: string
Default: "10s"

`conn_idle_timeout`

The maximum period of time a connection may remain idle before it is automatically closed. Accepts a Go duration string such as 100ms, 1s, or 5s.

Type: string
Default: "20s"

`tcp`

Advanced options for the underlying TCP connections used to communicate with brokers, including connection timeout and keep-alive settings.

Type: object

`tcp.connect_timeout`

The maximum amount of time a dial will wait for a connect to complete. A value of zero disables the timeout.

Type: string
Default: "0s"

`tcp.keep_alive.count`

The maximum number of keep-alive probes that can go unanswered before dropping a connection. A value of zero defaults to 9.

Type: int
Default: 9

`tcp.keep_alive.idle`

The time that a connection must remain idle before the first keep-alive probe is sent. A value of zero defaults to 15s; a negative value disables keep-alive probes.

Type: string
Default: "15s"

`tcp.keep_alive.interval`

The time between keep-alive probes. A value of zero defaults to 15s.

Type: string
Default: "15s"

`tcp.tcp_user_timeout`

Type: string
Default: "0s"

`timestamp`

An optional timestamp to set for each message. When left empty the current timestamp is used. This field supports interpolation functions.

Type: string

`timestamp_ms`

An optional timestamp to set for each message, expressed in milliseconds. 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") }

`inject_tracing_map`

A Bloblang mapping used to inject an object containing tracing propagation information into outbound messages. The specification of the injected fields matches the service-wide tracer.

Type: string

# Examples

inject_tracing_map: meta = @.merge(this)

inject_tracing_map: root.meta.span = this

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

`idempotent_write`

Enable the idempotent write producer option. This requires the IDEMPOTENT_WRITE permission on CLUSTER and can be disabled if this permission is not available.

Type: bool
Default: true

`acks`

The number of acknowledgements the broker's in-sync replica set must return before a produce request is considered complete.

Type: string
Default: "all"

Option	Summary
`all`	All in-sync replicas must acknowledge the write (equivalent to `acks=-1`). This is required when `idempotent_write` is enabled.
`leader`	Only the partition leader must acknowledge the write (equivalent to `acks=1`). Messages may be lost if the leader fails before the write is replicated.
`none`	The producer does not wait for any acknowledgement (equivalent to `acks=0`). This offers the highest throughput but messages may be lost.

`compression`

Optionally set an explicit compression type. The default preference is to use snappy when the broker supports it, and fall back to none if not.

Type: string
Options: lz4, snappy, gzip, none, zstd.

`allow_auto_topic_creation`

Whether to allow the broker to automatically create topics that do not yet exist when producing to them.

Type: bool
Default: true

`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 than an individual message may take, messages larger than this value will be rejected. This field corresponds to Kafka's max.message.bytes.

Type: string
Default: "1MiB"

# Examples

max_message_bytes: 100MB

max_message_bytes: 50mib

`broker_write_max_bytes`

The maximum number of bytes this output may 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

`max_buffered_records`

Sets the maximum number of records the client will buffer, blocking produces until records are finished if this limit is reached.

Type: int
Default: 10000

`max_buffered_bytes`

The maximum number of uncompressed bytes to buffer before blocking produces. A value of 0 disables the limit, in which case only max_buffered_records applies. This limit is checked after the record limit.

Type: string
Default: "0"

# Examples

max_buffered_bytes: 256MB

max_buffered_bytes: 50mib

`max_in_flight_requests`

The maximum number of produce requests that can be in flight on a single broker connection at any time. When idempotent_write is enabled the protocol caps this at 5 (1 for brokers older than Kafka v1.0.0). Higher values can improve throughput when idempotency is disabled but may result in out-of-order delivery.

Type: int
Default: 1

`record_retries`

The maximum number of times a record may be retried on failure before it is considered failed. A value of 0 allows unlimited retries. Records within the same partition fail together to preserve ordering. When idempotent_write is enabled, retries are only enforced when it is safe to do so.

Type: int
Default: 0

`record_delivery_timeout`

The maximum time a record may be buffered before it is considered failed, equivalent to Kafka's delivery.timeout.ms. A timeout results in the whole partition failing. A value of 0 disables the timeout. When idempotent_write is enabled, this is only enforced when it is safe to do so.

Type: string
Default: "0s"

Examples
Fields

Examples​

Fields​

seed_brokers​

topic​

key​

partition​

metadata​

metadata.include_prefixes​

metadata.include_patterns​

max_in_flight​

batching​

batching.count​

batching.byte_size​

batching.period​

batching.check​

batching.processors​

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​

sasl[].aws.tcp​

sasl[].aws.tcp.connect_timeout​

sasl[].aws.tcp.keep_alive.count​

sasl[].aws.tcp.keep_alive.idle​

sasl[].aws.tcp.keep_alive.interval​

sasl[].aws.tcp.tcp_user_timeout​

metadata_max_age​

request_timeout_overhead​

conn_idle_timeout​

tcp​

tcp.connect_timeout​

tcp.keep_alive.count​

tcp.keep_alive.idle​

tcp.keep_alive.interval​

tcp.tcp_user_timeout​

timestamp​

timestamp_ms​

inject_tracing_map​

partitioner​

idempotent_write​

acks​

compression​

allow_auto_topic_creation​

timeout​

max_message_bytes​

broker_write_max_bytes​

max_buffered_records​

max_buffered_bytes​

max_in_flight_requests​

record_retries​

record_delivery_timeout​

Examples

Fields

`seed_brokers`

`topic`

`key`

`partition`

`metadata`

`metadata.include_prefixes`

`metadata.include_patterns`

`max_in_flight`

`batching`

`batching.count`

`batching.byte_size`

`batching.period`

`batching.check`

`batching.processors`

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

`sasl[].aws.tcp`

`sasl[].aws.tcp.connect_timeout`

`sasl[].aws.tcp.keep_alive.count`

`sasl[].aws.tcp.keep_alive.idle`

`sasl[].aws.tcp.keep_alive.interval`

`sasl[].aws.tcp.tcp_user_timeout`

`metadata_max_age`

`request_timeout_overhead`

`conn_idle_timeout`

`tcp`

`tcp.connect_timeout`

`tcp.keep_alive.count`

`tcp.keep_alive.idle`

`tcp.keep_alive.interval`

`tcp.tcp_user_timeout`

`timestamp`

`timestamp_ms`

`inject_tracing_map`

`partitioner`

`idempotent_write`

`acks`

`compression`

`allow_auto_topic_creation`

`timeout`

`max_message_bytes`

`broker_write_max_bytes`

`max_buffered_records`

`max_buffered_bytes`

`max_in_flight_requests`

`record_retries`

`record_delivery_timeout`