health

Health Broker

Operator Redis broker memory probe. Requires a metrics scrape bearer token.

get/health/broker

Request

  • Base URL: https://api.ctindex.io
  • URL: https://api.ctindex.io/health/broker
  • Auth: none declared

Headers

authorizationstring nullable

Response

Successful Response

okboolean required

True when the INFO memory probe succeeded AND used_memory is below BROKER_MEMORY_HIGH_WATER_PCT of maxmemory. False on probe failure (fail-closed) or when the high-water mark is hit.

used_memory_bytesinteger nullable

Redis used_memory from INFO memory.

maxmemory_bytesinteger nullable

Redis maxmemory from INFO memory.

used_memory_pctnumber nullable

100 * used_memory / maxmemory. Null when maxmemory is 0.

maxmemory_policystring nullable

Redis maxmemory_policy (production is noeviction).

high_water_pctnumber required

Dispatch skip threshold (BROKER_MEMORY_HIGH_WATER_PCT, default 75).

headroom_bytesinteger nullable

maxmemory - used_memory, floored at 0.

headroom_pctnumber nullable

100 - used_memory_pct, floored at 0.

over_high_waterboolean required

True when used_memory_pct >= high_water_pct.

probe_okboolean required

True when INFO memory returned within BROKER_PROBE_TIMEOUT_MS.

probe_errorstring nullable

timeout | connection_error | no_maxmemory when probe_ok is false.

probe_timeout_msinteger required

Probe budget in milliseconds (BROKER_PROBE_TIMEOUT_MS, default 250).

skip_dispatchboolean required

True when producers must leave shards pending. True on high-water OR any probe failure (fail-closed).

skip_reasonstring nullable

broker_memory_high_water | broker_probe_timeout | broker_probe_failed | broker_maxmemory_unset.

Changes

No recorded changes to this operation across all 1 revision of this API.