Redis Streams

NAME	RUNTIME	TYPE	VERSION
redis_streams	wombat	sink	latest

Pushes messages to a Redis (v5.0+) Stream (which is created if it doesn't already exist) using the XADD command.

It's possible to specify a maximum length of the target stream by setting it to a value greater than 0, in which case this cap is applied only when Redis is able to remove a whole macro node, for efficiency.

Redis stream entries are key/value pairs, as such it is necessary to specify the key to be set to the body of the message. All metadata fields of the message will also be set as key/value pairs, if there is a key collision between a metadata item and the body then the body takes precedence.

Configuration

Name	Type	Optional	Secret	Description
url	string	no	no	The URL of the target Redis server. Database is optional and is supplied as the URL path.
kind	string	yes	no	Specifies a simple, cluster-aware, or failover-aware redis client. The value should be one of `simple`, `cluster` or `failover`. The value defaults to `"simple"`.
master	string	yes	no	Name of the redis master when `kind` is `failover`. The value defaults to `""`.
tls	tls	no	no	Custom TLS settings can be used to override system defaults.
stream	string	no	no	The stream to add messages to.
body_key	string	yes	no	A key to set the raw body of the message to. The value defaults to `"body"`.
max_length	int	yes	no	When greater than zero enforces a rough cap on the length of the target stream. The value defaults to `0`.
max_in_flight	int	yes	no	The maximum number of messages to have in flight at a given time. Increase this to improve throughput. The value defaults to `64`.
metadata	metadata	no	no	Specify criteria for which metadata values are included in the message body.
batching	batching	no	no	Allows you to configure a batching policy.

TLS Configuration

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether custom TLS settings are enabled. The value defaults to `false`.
skip_cert_verify	bool	yes	no	Whether to skip server side certificate verification. The value defaults to `false`.
enable_renegotiation	bool	yes	no	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`. The value defaults to `false`.
root_cas	string	yes	yes	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. The value defaults to `""`.
client_certs	[]client_certs	yes	no	A list of client certificates to use. . The value defaults to `[]`.

Metadata

Name	Type	Optional	Secret	Description
exclude_prefixes	[]string	yes	no	Provide a list of explicit metadata key prefixes to be excluded when adding metadata to sent messages. The value defaults to `[]`.

Batching

Name	Type	Optional	Secret	Description
count	int	yes	no	A number of messages at which the batch should be flushed. If `0` disables count based batching. The value defaults to `0`.
byte_size	int	yes	no	An amount of bytes at which the batch should be flushed. If `0` disables size based batching. The value defaults to `0`.
period	string	yes	no	A period in which an incomplete batch should be flushed regardless of its size. The value defaults to `""`.
check	string	yes	no	A Bloblang query that should return a boolean value indicating whether a message should end a batch. The value defaults to `""`.