XINFO STREAM
语法
XINFO STREAM key [FULL [COUNT count]]
- 可用版本
- Redis Open Source 5.0.0
- 时间复杂度
- O(1)
- ACL 类别
-
@read
,@stream
,@slow
,
此命令返回存储在 <key>
的 Stream 相关信息。
此命令提供的详细信息包括:
- length: Stream 中的条目数(参见
XLEN
) - radix-tree-keys: 底层基数树数据结构中的键数
- radix-tree-nodes: 底层基数树数据结构中的节点数
- groups: 为 Stream 定义的消费者组数量
- last-generated-id: Stream 中最新添加条目的 ID
- max-deleted-entry-id: 从 Stream 中删除的最大条目 ID
- entries-added: Stream 生命周期内添加的所有条目计数
- first-entry: Stream 中第一个条目的 ID 和字段-值元组
- last-entry: Stream 中最后一个条目的 ID 和字段-值元组
FULL
修饰符
可选的 FULL
修饰符提供了更详细的回复。提供该修饰符时,FULL
回复包括一个 entries 数组,其中包含按升序排列的 Stream 条目(ID 和字段-值元组)。此外,groups 也是一个数组,对于每个消费者组,它包含由 XINFO GROUPS
和 XINFO CONSUMERS
报告的信息。
为每个组提供以下信息:
- name: 消费者组的名称
- last-delivered-id: 传递给组中消费者最后一个条目的 ID
- entries-read: 传递给组中消费者最后一个条目的逻辑“读取计数器”
- lag: Stream 中仍在等待传递给组中消费者的条目数,如果无法确定此数量则为 NULL。
- pel-count: 组中待处理条目列表 (PEL) 的长度,这些条目已被传递但尚未确认
- pending: 包含待处理条目信息的数组(参见下方)
- consumers: 包含消费者信息的数组(参见下方)
为每个待处理条目提供以下信息:
- 消息的 ID。
- 获取了消息但尚未确认的消费者名称。我们称其为消息的当前 所有者。
- 消息传递给此消费者的 Unix 时间戳。
- 此消息已被传递的次数。
为每个消费者提供以下信息:
- name: 消费者的名称
- seen-time: 最后一次尝试交互的 Unix 时间戳(例如:
XREADGROUP
、XCLAIM
、XAUTOCLAIM
) - active-time: 最后一次成功交互的 Unix 时间戳(例如:实际读取了一些条目到 PEL 的
XREADGROUP
,实际认领了一些条目的XCLAIM
/XAUTOCLAIM
) - pel-count: PEL 中的条目数:消费者的待处理消息,这些消息已被传递但尚未确认
- pending: 包含待处理条目信息的数组,结构与上述相同,但省略了消费者名称(冗余,因为已经在特定消费者上下文中)
请注意,在 Redis 7.2.0 之前,seen-time 用于表示最后一次成功交互。在 7.2.0 中,添加了 active-time,并将 seen-time 更改为表示最后一次尝试交互。
可以使用 COUNT
选项来限制返回的 Stream 和 PEL 条目数量(返回前 <count>
个条目)。默认的 COUNT
是 10,COUNT
为 0 表示返回所有条目(如果 Stream 中有很多条目,执行时间可能会很长)。
示例
默认回复
> XINFO STREAM mystream
1) "length"
2) (integer) 2
3) "radix-tree-keys"
4) (integer) 1
5) "radix-tree-nodes"
6) (integer) 2
7) "last-generated-id"
8) "1638125141232-0"
9) "max-deleted-entry-id"
10) "0-0"
11) "entries-added"
12) (integer) 2
13) "recorded-first-entry-id"
14) "1719505260513-0"
15) "groups"
16) (integer) 1
17) "first-entry"
18) 1) "1638125133432-0"
2) 1) "message"
2) "apple"
19) "last-entry"
20) 1) "1638125141232-0"
2) 1) "message"
2) "banana"
完整回复
> XADD mystream * foo bar
"1638125133432-0"
> XADD mystream * foo bar2
"1638125141232-0"
> XGROUP CREATE mystream mygroup 0-0
OK
> XREADGROUP GROUP mygroup Alice COUNT 1 STREAMS mystream >
1) 1) "mystream"
2) 1) 1) "1638125133432-0"
2) 1) "foo"
2) "bar"
> XINFO STREAM mystream FULL
1) "length"
2) (integer) 2
3) "radix-tree-keys"
4) (integer) 1
5) "radix-tree-nodes"
6) (integer) 2
7) "last-generated-id"
8) "1638125141232-0"
9) "max-deleted-entry-id"
10) "0-0"
11) "entries-added"
12) (integer) 2
13) "recorded-first-entry-id"
14) "1719505260513-0"
15) "entries"
16) 1) 1) "1638125133432-0"
2) 1) "foo"
2) "bar"
2) 1) "1638125141232-0"
2) 1) "foo"
2) "bar2"
17) "groups"
18) 1) 1) "name"
2) "mygroup"
3) "last-delivered-id"
4) "1638125133432-0"
5) "entries-read"
6) (integer) 1
7) "lag"
8) (integer) 1
9) "pel-count"
10) (integer) 1
11) "pending"
12) 1) 1) "1638125133432-0"
2) "Alice"
3) (integer) 1638125153423
4) (integer) 1
13) "consumers"
14) 1) 1) "name"
2) "Alice"
3) "seen-time"
4) (integer) 1638125133422
5) "active-time"
6) (integer) 1638125133432
7) "pel-count"
8) (integer) 1
9) "pending"
10) 1) 1) "1638125133432-0"
2) (integer) 1638125133432
3) (integer) 1
RESP2 回复
以下之一
RESP3 回复
以下之一
历史
- 从 Redis 6.0.0 版本开始:添加了
FULL
修饰符。 - 从 Redis 7.0.0 版本开始:添加了
max-deleted-entry-id
、entries-added
、recorded-first-entry-id
、entries-read
和lag
字段 - 从 Redis 7.2.0 版本开始:添加了
active-time
字段,并更改了seen-time
的含义。