XINFO CONSUMERS

XINFO CONSUMERS key group

Available since:

Redis Open Source 5.0.0

Time complexity:

O(1)

ACL categories:

@read, @stream, @slow,

Compatibility:

Redis Enterprise and Redis Cloud compatibility

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)

Note that before Redis 7.2.0, idle used to denote the time passed since last successful interaction. In 7.2.0, inactive was added and idle was changed to denote the time passed since last attempted interaction.

Examples

> 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

Redis Enterprise and Redis Cloud compatibility

Return information

History

• Starting with Redis version 7.2.0: Added the inactive field, and changed the meaning of idle.