xinfo-consumers.3valkey - Man Page

XINFO CONSUMERS key group

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

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

• name: the consumer’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)

valkey-protocol(7) Array reply: a list of consumers and their attributes.

O(1)

@read @slow @stream

• Available since: 5.0.0
• Changed in 7.2.0: Added the inactive field, and changed the meaning of idle.

> XINFO CONSUMERS mystream mygroup
1) 1) name
   2) "Alice"
   3) pending
   4) (integer) 1
   5) idle
   6) (integer) 9104628
   7) inactive
   8) (integer) 18104698
2) 1) name
   2) "Bob"
   3) pending
   4) (integer) 1
   5) idle
   6) (integer) 83841983
   7) inactive
   8) (integer) 993841998

xack(3valkey), xadd(3valkey), xautoclaim(3valkey), xclaim(3valkey), xdel(3valkey), xgroup(3valkey), xgroup-create(3valkey), xgroup-createconsumer(3valkey), xgroup-delconsumer(3valkey), xgroup-destroy(3valkey), xgroup-help(3valkey), xgroup-setid(3valkey), xinfo(3valkey), xinfo-groups(3valkey), xinfo-help(3valkey), xinfo-stream(3valkey), xlen(3valkey), xpending(3valkey), xrange(3valkey), xread(3valkey), xreadgroup(3valkey), xrevrange(3valkey), xsetid(3valkey), xtrim(3valkey)