Skip to main content

consumers_lag_summary

Creates, updates, deletes, gets or lists a consumers_lag_summary resource.

Overview

Nameconsumers_lag_summary
TypeResource
Idconfluent.kafka.consumers_lag_summary

Fields

NameDatatypeDescription
cluster_idstring
consumer_group_idstring
kindstring
max_laginteger
max_lag_client_idstring
max_lag_consumerobject
max_lag_consumer_idstring
max_lag_instance_idstring
max_lag_partitionobject
max_lag_partition_idinteger
max_lag_topic_namestring
metadataobject
total_laginteger

Methods

NameAccessible byRequired ParamsDescription
get_kafka_consumer_group_lag_summarySELECTcluster_id, consumer_group_idGenerally Available Available in dedicated clusters only Return the maximum and total lag of the consumers belonging to the specified consumer group.

SELECT examples

Generally Available Available in dedicated clusters only Return the maximum and total lag of the consumers belonging to the specified consumer group.

SELECT
cluster_id,
consumer_group_id,
kind,
max_lag,
max_lag_client_id,
max_lag_consumer,
max_lag_consumer_id,
max_lag_instance_id,
max_lag_partition,
max_lag_partition_id,
max_lag_topic_name,
metadata,
total_lag
FROM confluent.kafka.consumers_lag_summary
WHERE cluster_id = '{{ cluster_id }}'
AND consumer_group_id = '{{ consumer_group_id }}';