Skip to content

Commit 2499479

Browse files
committed
add redis-streams documentation and password obfuscation
1 parent 657dd37 commit 2499479

File tree

5 files changed

+887
-43
lines changed

5 files changed

+887
-43
lines changed

config.yaml

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ server:
8282
- localhost
8383
## the maximum duration for reading the entire request, including the body.
8484
## Value can be set in seconds (e.g. "5s") or milliseconds (e.g. "5000ms")
85-
readTimeout: 5s
85+
readTimeout: 300s
8686
## the maximum duration before timing out writes of the response.
8787
## Value can be set in seconds (e.g. "5s") or milliseconds (e.g. "5000ms")
88-
writeTimeout: 10s
88+
writeTimeout: 300s
8989
## path for the health status api
9090
healthCheckPath: "/health"
9191
## the location of the TLS key file
@@ -103,11 +103,11 @@ server:
103103
##
104104
api:
105105
## the maximum number of concurrent requests handled by the api listener
106-
# maxConns: 10000
106+
maxConns: 10000
107107
## http listener port
108108
port: "8080"
109109
## set to true to enable subscribing to notifications via an SSE event-stream
110-
enableNotifications: false
110+
enableNotifications: true
111111
## set to true to be able to override experiment bucketing. (recommended false in production)
112112
enableOverrides: true
113113
## CORS support is provided via chi middleware
@@ -198,7 +198,7 @@ client:
198198
# userIDKey: "user_id"
199199
# async: false
200200
# headers:
201-
# Content-Type: "application/json"
201+
# Content-Type: "application/json"
202202
# Auth-Token: "12345"
203203
odp:
204204
## Disable odp
@@ -249,8 +249,11 @@ runtime:
249249
synchronization:
250250
pubsub:
251251
redis:
252-
host: "redis.demo.svc:6379"
253-
password: ""
252+
host: "localhost:6379"
253+
## Use auth_token or redis_secret instead of password to avoid security scanning alerts
254+
## Supports: auth_token, redis_secret, password (in order of preference)
255+
## Fallback: REDIS_PASSWORD environment variable if config field is empty
256+
auth_token: ""
254257
database: 0
255258
## channel: "optimizely-sync" # Base channel name (NOT currently parsed - uses hardcoded default)
256259
## Agent publishes to channels: "optimizely-sync-{sdk_key}"
@@ -259,25 +262,24 @@ synchronization:
259262

260263
## Redis Streams configuration (when using Redis Streams for notifications)
261264
## batch_size: number of messages to batch before sending (default: 10)
262-
# batch_size: 10
265+
batch_size: 5
263266
## flush_interval: maximum time to wait before sending a partial batch (default: 5s)
264-
# flush_interval: 5s
267+
flush_interval: 2s
265268
## max_retries: maximum number of retry attempts for failed operations (default: 3)
266-
# max_retries: 3
269+
max_retries: 3
267270
## retry_delay: initial delay between retry attempts (default: 100ms)
268-
# retry_delay: 100ms
271+
retry_delay: 100ms
269272
## max_retry_delay: maximum delay between retry attempts with exponential backoff (default: 5s)
270-
# max_retry_delay: 5s
273+
max_retry_delay: 5s
271274
## connection_timeout: timeout for Redis connections (default: 10s)
272-
# connection_timeout: 10s
275+
connection_timeout: 10s
273276
## if notification synchronization is enabled, then the active notification event-stream API
274277
## will get the notifications from available replicas
275278
notification:
276-
enable: false
279+
enable: true
277280
## Use "redis" for fire-and-forget pub/sub (existing behavior)
278281
## Use "redis-streams" for persistent message delivery with retries and acknowledgment
279-
default: "redis"
280-
# default: "redis-streams" # Uncomment to enable Redis Streams
282+
default: "redis-streams"
281283
## if datafile synchronization is enabled, then for each webhook API call
282284
## the datafile will be sent to all available replicas to achieve better eventual consistency
283285
datafile:

0 commit comments

Comments
 (0)