redis_hash
Sets Redis hash objects using the HMSET command.
-
Common
-
Advanced
outputs:
label: ""
redis_hash:
url: "" # No default (required)
key: "" # No default (required)
walk_metadata: false
walk_json_object: false
fields: {}
max_in_flight: 64outputs:
label: ""
redis_hash:
url: "" # No default (required)
kind: simple
master: ""
client_name: redpanda-connect
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
key: "" # No default (required)
walk_metadata: false
walk_json_object: false
fields: {}
max_in_flight: 64The field key supports interpolation functions, allowing you to create a unique key for each message.
The field fields allows you to specify an explicit map of field names to interpolated values, also evaluated per message of a batch:
output:
redis_hash:
url: tcp://localhost:6379
key: ${!json("id")}
fields:
topic: ${!meta("kafka_topic")}
partition: ${!meta("kafka_partition")}
content: ${!json("document.text")}If the field walk_metadata is set to true then Redpanda Connect will walk all metadata fields of messages and add them to the list of hash fields to set.
If the field walk_json_object is set to true then Redpanda Connect will walk each message as a JSON object, extracting keys and the string representation of their value and adds them to the list of hash fields to set.
The order of hash field extraction is as follows:
-
Metadata (if enabled)
-
JSON object (if enabled)
-
Explicit fields
Where latter stages will overwrite matching field names of a former stage.
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.
Fields
client_name
Set the client name for the Redis connection.
Requires version 4.82.0 or later.
Type: string
Default: redpanda-connect
fields
A map of key/value pairs to set as hash fields. This field supports interpolation functions.
Type: string
Default: {}
key
The key for each message, function interpolations should be used to create a unique key per message. This field supports interpolation functions.
Type: string
# Examples:
key: ${! @.kafka_key }
# ---
key: ${! this.doc.id }
# ---
key: ${! counter() }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: mymastermax_in_flight
The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
Type: int
Default: 64
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.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: object
Default: []
# Examples:
client_certs:
- cert: foo
key: bar
# ---
client_certs:
- cert_file: ./example.pem
key_file: ./example.keytls.client_certs[].key
A plain text certificate key to use.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
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.
Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
Type: string
Default: ""
# Examples:
password: foo
# ---
password: ${KEY_PASSWORD}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.
Requires version 3.45.0 or later.
Type: bool
Default: false
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.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
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.pemtls.skip_cert_verify
Whether to skip server side certificate verification.
Type: bool
Default: false
url
The URL of the target Redis server. Database is optional and is supplied as the URL path.
Type: string
# Examples:
url: redis://:6379
# ---
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