Synadia Connect

Redis Streams

NAMERUNTIMETYPEVERSION
redis_streamswombatsourcelatest

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

NameTypeOptionalSecretDescription
urlstringnonoThe URL of the target Redis server. Database is optional and is supplied as the URL path.
kindstringyesnoSpecifies a simple, cluster-aware, or failover-aware redis client. The value should be one of simple, cluster or failover. The value defaults to "simple".
masterstringyesnoName of the redis master when kind is failover. The value defaults to "".
tlstlsnonoCustom TLS settings can be used to override system defaults.
body_keystringyesnoThe 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[]stringnonoA list of streams to consume from.
auto_replay_nacksboolyesnoWhether 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.
limitintyesnoThe maximum number of messages to consume from a single request. The value defaults to 10.
client_idstringyesnoAn identifier for the client connection. The value defaults to "".
consumer_groupstringyesnoAn identifier for the consumer group of the stream. The value defaults to "".
create_streamsboolyesnoCreate subscribed streams if they do not exist (MKSTREAM option). The value defaults to true.
start_from_oldestboolyesnoIf 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_periodstringyesnoThe period of time between each commit of the current offset. Offsets are always committed during shutdown. The value defaults to "1s".
timeoutstringyesnoThe length of time to poll for new messages before reattempting. The value defaults to "1s".

TLS Configuration

NameTypeOptionalSecretDescription
enabledboolyesnoWhether custom TLS settings are enabled. The value defaults to false.
skip_cert_verifyboolyesnoWhether to skip server side certificate verification. The value defaults to false.
enable_renegotiationboolyesnoWhether 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_casstringyesyesAn 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_certsyesnoA list of client certificates to use. . The value defaults to [].
Previous
Redis Scan