Apache Kafka ConsumerGroupDescribe

Apache Kafka ConsumerGroupDescribe

Certified

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.

yaml
type: io.kestra.plugin.kafka.ConsumerGroupDescribe

Check the lag of a tenant's processing consumer group

yaml
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
SubTypestring

Consumer group IDs to describe

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.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultPT30S

AdminClient call timeout

Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds). Distinct from the task-level timeout, which lets the worker kill the task without retrying it.

SubTypeobject

Described consumer groups

Each entry contains groupId, state, members (memberId, clientId, host, assignedPartitions) and offsets (topic, partition, currentOffset, endOffset, lag).