XINFO CONSUMERS

Syntax

  1. XINFO CONSUMERS key group

ACL categories: @read, @stream, @slow

XINFO CONSUMERS command returns the list of consumers that belong to the <group> consumer group of the stream stored at <key>.

The following information is provided for each consumer in the group:

  • name: The consumer group’s name
  • pending: The number of entries in the PEL: pending messages for the consumer, which are messages that were delivered but are yet to be acknowledged
  • idle: the number of milliseconds that have passed since the consumer’s last attempted interaction (Examples: XREADGROUP, XCLAIM, XAUTOCLAIM)
  • inactive: the number of milliseconds that have passed since the consumer’s last successful interaction (Examples: XREADGROUP that actually read some entries into the PEL, XCLAIM/XAUTOCLAIM that actually claimed some entries)

Return

Array reply: a list of consumers.

Example

  1. dragonfly> XINFO CONSUMERS mystream mygroup
  2. 1) 1) name
  3.    2) "Alice"
  4.    3) pending
  5.    4) (integer) 1
  6.    5) idle
  7.    6) (integer) 9104628
  8.    7) inactive
  9.    8) (integer) 18104698
  10. 2) 1) name
  11.    2) "Bob"
  12.    3) pending
  13.    4) (integer) 1
  14.    5) idle
  15.    6) (integer) 83841983
  16.    7) inactive
  17.    8) (integer) 993841998