XINFO GROUPS - Upstash Documentation

Use XINFO GROUPS to list the consumer groups defined on a stream.

Each group is reported with its name, its number of consumers, how many entries are pending across the group, the ID it has delivered up to, and its lag, meaning how many entries in the stream it has not read yet. Lag and pending count together are the standard health signals for a stream consumer: a growing lag means consumers cannot keep up, while a growing pending count means they read entries but do not acknowledge them.

Syntax#

XINFO GROUPS <key>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.

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	Array of flat group-metadata arrays
RESP3	Array of group-metadata maps

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 GROUPS my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const result = await redis.xinfo("my-key", { type: "GROUPS" });console.log(result);

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.xinfo_groups("my-key")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.xinfo("GROUPS", "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.xInfoGroups("my-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.xinfo_groups("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.XInfoGroups(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.xinfoGroups("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_groups("my-key")?;    println!("{result:?}");    Ok(())}