Redis Destination Config Reference

Redis is a key-value store destination. RudderStack writes the traits from each identify event to the user’s key in Redis — user:<userId> — so you can read a user’s latest profile in real time. Redis receives only identify events, and only those with a userId. One without fails.

In a Redis destination spec:

• type: redis
• definition_version: 1

Sample configuration

version: rudder/v1
kind: destination
metadata:
  name: redis-prod
spec:
  id: redis-prod
  display_name: Redis Production
  type: redis
  definition_version: 1
  enabled: true
  config:
    address: redis.internal.example.com:6379
    password: "{{ .REDIS_PASSWORD }}"
    cluster_mode: false
    database: "2"
    prefix: rudderstack

    secure: true
    skip_verify: false
    ca_certificate: "{{ .REDIS_CA_CERTIFICATE }}"

    use_json_module: false

    connection_mode:
      web: cloud
      cloud: cloud
    consent_management:
      web:
        - provider: oneTrust
          consents:
            - analytics

The above example connects to a single Redis server over TLS. cluster_mode defaults to true, so a single server needs cluster_mode: false, which also lets it pick a database — see Connection.

Config keys

config accepts only the keys listed below. The shared config key rules cover unknown keys, defaults, and immutability.

Connection

cluster_mode: false
database: "2"

TLS

Storage format

By default, each user’s key holds a Redis hash. RudderStack merges context.traits and traits into it, with traits winning, flattens nested traits with . — location.city — and stores every value as a string. Fields the event doesn’t carry are left as they were. See Identify for an example.

Per-source keys

Both keys are objects keyed by the local source type — the tokens listed under Source types. A key naming a source type this destination doesn’t support fails validation.

connection_mode:
  web: cloud
  cloud: cloud

Source types

Redis accepts events from these source types in the mentioned connection modes:

Every source type is cloud only — events reach Redis from RudderStack’s servers, never in device mode.

warehouse is the token a Reverse ETL source resolves to. Rudder CLI manages the destination’s warehouse entry — if the destination is connected to a Reverse ETL source, set connection_mode.warehouse: cloud in its spec, or apply removes it.

Rudder CLI can also declare the Reverse ETL connection itself, for the types listed under Supported destinations — see Manage Reverse ETL Connections using Rudder CLI.

The dashboard additionally offers Redis to AMP and Shopify sources. Rudder CLI doesn’t manage those connections, so amp and shopify are invalid here.

Connect a source

An event stream connection to this destination is checked against two rules at validate time.

The source’s type must be supported. A source’s type resolves to one of the tokens above before the check — a JavaScript source resolves to web, and webhook and server-side SDK sources resolve to cloud. Every type an event stream source can resolve to is supported here, so this check always passes.

The destination config must carry a connection_mode entry for that source type. This lives on the destination spec, not on the connection spec. Without it:

destination 'redis-prod' config has no 'connection_mode' entry for source type 'web'

Redis needs no additional config keys to connect a source of any type.

Secrets

password and ca_certificate are the secret keys. Write each as a {{ .VAR }} reference and supply the value at apply time:

config:
  password: "{{ .REDIS_PASSWORD }}"
  ca_certificate: "{{ .REDIS_CA_CERTIFICATE }}"

export RUDDER_REDIS_PASSWORD="..."
export RUDDER_REDIS_CA_CERTIFICATE="$(cat ca.pem)"
rudder-cli apply

# or
rudder-cli apply --var-file secrets.vars.yaml

Note that:

• rudder-cli import writes only the secrets the API returns, as {{ .VAR }} references, and leaves the others out. Add any secret key it leaves out, then supply the variables before you apply — see Secrets.
• ca_certificate spans several lines. Keep its reference quoted and on its own, as above, and supply the certificate with its line breaks — as is from the environment, or as a | block in a var file. A bare reference, or one inside a longer string, breaks the YAML or folds the line breaks into spaces.
• A certificate with its line breaks written as \n also works, but only inside a double-quoted reference. A single-quoted reference, like the ones rudder-cli import writes, keeps the \n as literal text.

See How to Use Variable Substitution in Rudder CLI.

Changes by release

No changes since this type became available.

For changes across every destination type, see Destination Type Changes by Release.

See more

• Redis Destination for how RudderStack stores traits, custom prefixes, and deleting a user
• Destination Type Reference for Rudder CLI for the rules shared across destination types
• Destination YAML Reference for the spec envelope