XINFO STREAM - Upstash Documentation

Use XINFO STREAM to get information about a stream.

The default reply summarizes the stream: how many entries it holds, the last generated ID, the number of consumer groups, and the first and last entries. FULL returns the detailed form instead, walking the entries along with every group, consumer, and pending entry, with COUNT limiting how many items each part of that reply contains (COUNT 0 means no limit).

Use the summary for monitoring and the full form when debugging a group that appears stuck, since it shows exactly which entries are pending and who owns them.

Syntax#

XINFO STREAM <key> [FULL [COUNT <count>]]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`FULL [COUNT <count>]`	No	No	Return the full report, including entries and consumer-group state. `COUNT` caps how many entries each section lists; `0` returns all of them.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Flat array of alternating keys and values
RESP3	Map

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

XINFO STREAM my-key

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.xinfo("STREAM", "my-key");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.xInfoStream("my-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.xinfo_stream("my-key")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.XInfoStream(context.Background(), "my-key").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.xinfoStream("my-key");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.xinfo_stream("my-key")?;    println!("{result:?}");    Ok(())}