github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/inputs/redis_list.md (about) 1 --- 2 title: redis_list 3 type: input 4 status: stable 5 categories: ["Services"] 6 --- 7 8 <!-- 9 THIS FILE IS AUTOGENERATED! 10 11 To make changes please edit the contents of: 12 lib/input/redis_list.go 13 --> 14 15 import Tabs from '@theme/Tabs'; 16 import TabItem from '@theme/TabItem'; 17 18 19 Pops messages from the beginning of a Redis list using the BLPop command. 20 21 22 <Tabs defaultValue="common" values={[ 23 { label: 'Common', value: 'common', }, 24 { label: 'Advanced', value: 'advanced', }, 25 ]}> 26 27 <TabItem value="common"> 28 29 ```yaml 30 # Common config fields, showing default values 31 input: 32 label: "" 33 redis_list: 34 url: tcp://localhost:6379 35 key: benthos_list 36 ``` 37 38 </TabItem> 39 <TabItem value="advanced"> 40 41 ```yaml 42 # All config fields, showing default values 43 input: 44 label: "" 45 redis_list: 46 url: tcp://localhost:6379 47 kind: simple 48 master: "" 49 tls: 50 enabled: false 51 skip_cert_verify: false 52 enable_renegotiation: false 53 root_cas: "" 54 root_cas_file: "" 55 client_certs: [] 56 key: benthos_list 57 timeout: 5s 58 ``` 59 60 </TabItem> 61 </Tabs> 62 63 ## Fields 64 65 ### `url` 66 67 The URL of the target Redis server. Database is optional and is supplied as the URL path. The scheme `tcp` is equivalent to `redis`. 68 69 70 Type: `string` 71 Default: `"tcp://localhost:6379"` 72 73 ```yaml 74 # Examples 75 76 url: :6397 77 78 url: localhost:6397 79 80 url: redis://localhost:6379 81 82 url: redis://:foopassword@redisplace:6379 83 84 url: redis://localhost:6379/1 85 86 url: redis://localhost:6379/1,redis://localhost:6380/1 87 ``` 88 89 ### `kind` 90 91 Specifies a simple, cluster-aware, or failover-aware redis client. 92 93 94 Type: `string` 95 Default: `"simple"` 96 97 ```yaml 98 # Examples 99 100 kind: simple 101 102 kind: cluster 103 104 kind: failover 105 ``` 106 107 ### `master` 108 109 Name of the redis master when `kind` is `failover` 110 111 112 Type: `string` 113 Default: `""` 114 115 ```yaml 116 # Examples 117 118 master: mymaster 119 ``` 120 121 ### `tls` 122 123 Custom TLS settings can be used to override system defaults. 124 125 **Troubleshooting** 126 127 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. 128 129 130 Type: `object` 131 132 ### `tls.enabled` 133 134 Whether custom TLS settings are enabled. 135 136 137 Type: `bool` 138 Default: `false` 139 140 ### `tls.skip_cert_verify` 141 142 Whether to skip server side certificate verification. 143 144 145 Type: `bool` 146 Default: `false` 147 148 ### `tls.enable_renegotiation` 149 150 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`. 151 152 153 Type: `bool` 154 Default: `false` 155 Requires version 3.45.0 or newer 156 157 ### `tls.root_cas` 158 159 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. 160 161 162 Type: `string` 163 Default: `""` 164 165 ```yaml 166 # Examples 167 168 root_cas: |- 169 -----BEGIN CERTIFICATE----- 170 ... 171 -----END CERTIFICATE----- 172 ``` 173 174 ### `tls.root_cas_file` 175 176 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. 177 178 179 Type: `string` 180 Default: `""` 181 182 ```yaml 183 # Examples 184 185 root_cas_file: ./root_cas.pem 186 ``` 187 188 ### `tls.client_certs` 189 190 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. 191 192 193 Type: `array` 194 Default: `[]` 195 196 ```yaml 197 # Examples 198 199 client_certs: 200 - cert: foo 201 key: bar 202 203 client_certs: 204 - cert_file: ./example.pem 205 key_file: ./example.key 206 ``` 207 208 ### `tls.client_certs[].cert` 209 210 A plain text certificate to use. 211 212 213 Type: `string` 214 Default: `""` 215 216 ### `tls.client_certs[].key` 217 218 A plain text certificate key to use. 219 220 221 Type: `string` 222 Default: `""` 223 224 ### `tls.client_certs[].cert_file` 225 226 The path to a certificate to use. 227 228 229 Type: `string` 230 Default: `""` 231 232 ### `tls.client_certs[].key_file` 233 234 The path of a certificate key to use. 235 236 237 Type: `string` 238 Default: `""` 239 240 ### `key` 241 242 The key of a list to read from. 243 244 245 Type: `string` 246 Default: `"benthos_list"` 247 248 ### `timeout` 249 250 The length of time to poll for new messages before reattempting. 251 252 253 Type: `string` 254 Default: `"5s"` 255 256