Confluent Documentation

confluent kafka consumer group lag describe¶

Description¶

Describe consumer lag for a Kafka topic partition consumed by a consumer group. Only available for dedicated Kafka clusters.

confluent kafka consumer group lag describe <group> [flags]

Describe consumer lag for a Kafka topic partition consumed by a consumer group.

confluent kafka consumer group lag describe <group> [flags]

Flags¶

    --topic string         REQUIRED: Topic name.
    --partition int32      REQUIRED: Partition ID.
    --cluster string       Kafka cluster ID.
    --context string       CLI context name.
    --environment string   Environment ID.
-o, --output string        Specify the output format as "human", "json", or "yaml". (default "human")

    --topic string                        REQUIRED: Topic name.
    --partition int32                     REQUIRED: Partition ID.
    --url string                          Base URL of REST Proxy Endpoint of Kafka Cluster (include "/kafka" for embedded Rest Proxy). Must set flag or CONFLUENT_REST_URL.
    --certificate-authority-path string   Path to a PEM-encoded Certificate Authority to verify the Confluent REST Proxy.
    --client-cert-path string             Path to client cert to be verified by Confluent REST Proxy. Include for mTLS authentication.
    --client-key-path string              Path to client private key, include for mTLS authentication.
    --no-authentication                   Include if requests should be made without authentication headers and user will not be prompted for credentials.
    --prompt                              Bypass use of available login credentials and prompt for Kafka Rest credentials.
    --context string                      CLI context name.
-o, --output string                       Specify the output format as "human", "json", or "yaml". (default "human")

Global Flags¶

-h, --help            Show help for this command.
    --unsafe-trace    Equivalent to -vvvv, but also log HTTP requests and responses which might contain plaintext secrets.
-v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

Examples¶

Describe the consumer lag for topic “my-topic” partition “0” consumed by consumer group “my-consumer-group”.

confluent kafka consumer group lag describe my-consumer-group --topic my-topic --partition 0

See Also¶

confluent kafka consumer group lag - View consumer group lag.