Skip to main content

redis_scan

Scans the set of keys in the current selected database and emits Redis string or hash values.

# Common config fields, showing default values
input:
  label: ""
  redis_scan:
    url: redis://:6397 # No default (required)
    auto_replay_nacks: true
    match: ""
    data_type: string
    value_format: structured

Optionally, iterates only elements matching a blob-style pattern. For example:

  • *foo* iterates only keys which contain foo in it.
  • foo* iterates only keys starting with foo.

By default this input treats matched keys as Redis string data type keys, reads them with GET, and generates a message for each key value pair in the following format:

{"key":"foo","value":"bar"}

When data_type is set to hash this input treats matched keys as Redis hash data type keys. It uses HSCAN to iterate over each field and its value.

By default, value_format is structured in order to preserve the original redis_scan message shape of {"key":"...","value":"..."}. Set it to raw to emit Redis values as raw message payloads. Raw messages set Redis identity fields as metadata, using redis_key for Redis keys and redis_hash_field for hash fields.

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

tls.skip_cert_verify​

Whether to skip server side certificate verification.

Type: bool
Default: false

tls.enable_renegotiation​

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.

Type: bool
Default: false
Requires version 1.0.0 or newer

tls.root_cas​

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.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

# Examples

root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

tls.root_cas_file​

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Type: string
Default: ""

# Examples

root_cas_file: ./root_cas.pem

tls.client_certs​

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array
Default: []

# Examples

client_certs:
  - cert: foo
    key: bar

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

tls.client_certs[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

Type: string
Default: ""

tls.client_certs[].password​

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

# Examples

password: foo

password: ${KEY_PASSWORD}

auto_replay_nacks​

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.

Type: bool
Default: true

match​

Iterates only elements matching the optional glob-style pattern. By default, it matches all elements.

Type: string
Default: ""

# Examples

match: '*'

match: 1*

match: foo*

match: foo

match: '*4*'

data_type​

The Redis data type to read for each matched key. string reads matched keys with GET. hash scans matched keys with HSCAN and emits each hash field value as an individual message.

Type: string
Default: "string"
Options: string, hash.

value_format​

The Bento message shape to emit for Redis values. The structured format preserves the original redis_scan key/value object shape, while raw emits Redis values as message payloads and stores Redis identity in metadata.

Type: string
Default: "structured"
Options: structured, raw.

scan_count​

An optional Redis SCAN count hint for key scanning. A value of 0 preserves the Redis default scan behaviour.

Type: int
Default: 0

hash_scan_count​

An optional Redis HSCAN count hint for hash field scanning. A value of 0 preserves the Redis default scan behaviour.

Type: int
Default: 0