Redis

This extension may be referenced by the qualified name envoy.health_checkers.redis

Note

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

Redis health checker configuration overview.

extensions.health_checkers.redis.v3.Redis

[extensions.health_checkers.redis.v3.Redis proto]

  1. {
  2.   "key": "..."
  3. }

key

(string) If set, optionally perform EXISTS <key> instead of PING. A return value from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance by setting the specified key to any value and waiting for traffic to drain.