Apache Kafka ConsumerGroupDescribe
CertifiedDescribe Kafka consumer groups
Apache Kafka ConsumerGroupDescribe
Describe Kafka consumer groups
Returns state, members and per-partition committed offset/lag for the given consumer groups using the Kafka AdminClient.
Fails with GroupIdNotFoundException if a group does not exist.
type: io.kestra.plugin.kafka.ConsumerGroupDescribeExamples
Check the lag of a tenant's processing consumer group
id: kafka_consumer_group_describe
namespace: company.team
tasks:
- id: describe_groups
type: io.kestra.plugin.kafka.ConsumerGroupDescribe
properties:
bootstrap.servers: localhost:9092
groupIds:
- tenant-acme-orders-processor
Properties
groupIds *Requiredarray
Consumer group IDs to describe
properties *Requiredobject
Kafka AdminClient properties
Must include bootstrap.servers; accepts any Kafka AdminClient config. Provide base64-encoded content for ssl.keystore.location and ssl.truststore.location when using SSL.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
timeout string
PT30SAdminClient call timeout
Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds).
Outputs
groups array
Described consumer groups
Each entry contains groupId, state, members (memberId, clientId, host, assignedPartitions) and offsets (topic, partition, currentOffset, endOffset, lag).
