redis_pubsub
Publishes messages through the Redis PubSub model. It is not possible to guarantee that messages have been received.
- Common
- Advanced
# Common config fields, showing default values
output:
label: ""
redis_pubsub:
url: redis://:6397 # No default (required)
channel: "" # No default (required)
max_in_flight: 64
batching:
count: 0
byte_size: 0
period: ""
check: ""
# All config fields, showing default values
output:
label: ""
redis_pubsub:
url: redis://:6397 # No default (required)
kind: simple
master: ""
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
channel: "" # No default (required)
max_in_flight: 64
batching:
count: 0
byte_size: 0
period: ""
check: ""
processors: [] # No default (optional)
This output will interpolate functions within the channel field, you can find a list of functions here.
Performance
This output benefits from sending multiple messages in flight in parallel for
improved performance. You can tune the max number of in flight messages (or
message batches) with the field max_in_flight
.
This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. You can find out more in this doc.
Fields
url
The URL of the target Redis server. Database is optional and is supplied as the URL path.
Type: string
# Examples
url: redis://:6397
url: redis://localhost:6379
url: redis://foousername:foopassword@redisplace:6379
url: redis://:foopassword@redisplace:6379
url: redis://localhost:6379/1
url: redis://localhost:6379/1,redis://localhost:6380/1
kind
Specifies a simple, cluster-aware, or failover-aware redis client.
Type: string
Default: "simple"
Options: simple
, cluster
, failover
.
master
Name of the redis master when kind
is failover
Type: string
Default: ""
# Examples
master: mymaster
tls
Custom TLS settings can be used to override system defaults.
Troubleshooting
Some cloud hosted instances of Redis (such as Azure Cache) might need some hand holding in order to establish stable connections. Unfortunately, it is often the case that TLS issues will manifest as generic error messages such as "i/o timeout". If you're using TLS and are seeing connectivity problems consider setting enable_renegotiation
to true
, and ensuring that the server supports at least TLS version 1.2.
Type: object
tls.enabled
Whether custom TLS settings are enabled.
Type: bool
Default: false