Skip to main content
Version: 0.6.x
input/redisINPUTBUFFERPROCESSOROUTPUT

Redis

The Redis input reads from Redis with both standalone and cluster connection modes, and supports Subscribe (channels / patterns) and List consumption modes. As a channel-based input it follows the engine's cancellation-safety contract: dropping a pending read never loses an already-decoded message (see Input Delivery Semantics).

Configuration​

FieldTypeRequiredDefaultDescription
typestringyes—Constant value "redis"
modeobjectyes—Connection mode (tagged enum), see table below
redis_typeobjectyes—Consumption mode (tagged enum), see table below

mode​

FieldTypeRequiredDescription
typestringyes"single" or "cluster"
urlstringyes (single)Standalone URL, e.g. redis://host:6379
urlsarray<string>yes (cluster)List of cluster node URLs

redis_type (subscribe)​

FieldTypeRequiredDescription
typestringyes"subscribe"
subscribeobjectyesSubscription configuration, see below

subscribe:

FieldTypeRequiredDescription
typestringyes"channels" or "patterns"
channelsarray<string>yes (channels)List of channels
patternsarray<string>yes (patterns)List of patterns

redis_type (list)​

FieldTypeRequiredDescription
typestringyes"list"
listarray<string>yesList of Redis list keys to consume

Examples​

input:
type: "redis"
mode:
type: "single"
url: "redis://localhost:6379"
redis_type:
type: "subscribe"
subscribe:
type: "channels"
channels:
- "news"
- "events"
input:
type: "redis"
mode:
type: "single"
url: "redis://localhost:6379"
redis_type:
type: "list"
list:
- "tasks"
- "notifications"