Redis Streams

Pulls messages from Redis (v5.0+) streams with the XREADGROUP command. The client_id should be unique for each consumer of a group.

Redis stream entries are key/value pairs, as such it is necessary to specify the key that contains the body of the message. All other keys/value pairs are saved as metadata fields.

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.
body_key	string	yes	no	The field key to extract the raw message from. All other keys will be stored in the message as metadata. The value defaults to `"body"`.
streams	[]string	no	no	A list of streams to consume from.
auto_replay_nacks	bool	yes	no	Whether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to `false` these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation. The value defaults to `true`.
limit	int	yes	no	The maximum number of messages to consume from a single request. The value defaults to `10`.
client_id	string	yes	no	An identifier for the client connection. The value defaults to `""`.
consumer_group	string	yes	no	An identifier for the consumer group of the stream. The value defaults to `""`.
create_streams	bool	yes	no	Create subscribed streams if they do not exist (MKSTREAM option). The value defaults to `true`.
start_from_oldest	bool	yes	no	If an offset is not found for a stream, determines whether to consume from the oldest available offset, otherwise messages are consumed from the latest offset. The value defaults to `true`.
commit_period	string	yes	no	The period of time between each commit of the current offset. Offsets are always committed during shutdown. The value defaults to `"1s"`.
timeout	string	yes	no	The length of time to poll for new messages before reattempting. The value defaults to `"1s"`.

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