consumers_lags

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

Overview

Name	consumers_lags
Type	Resource
Id	confluent.kafka.consumers_lags

Fields

The following fields are returned by SELECT queries:

get_kafka_consumer_lag

The consumer lag.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_group_id	string
consumer_id	string
instance_id	string
partition_id	integer
topic_name	string
current_offset	integer (int64)
kind	string
lag	integer (int64)
log_end_offset	integer (int64)
metadata	object

list_kafka_consumer_lags

The list of consumer lags.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_group_id	string
consumer_id	string
instance_id	string
partition_id	integer
topic_name	string
current_offset	integer (int64)
kind	string
lag	integer (int64)
log_end_offset	integer (int64)
metadata	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_consumer_lag	select	cluster_id, consumer_group_id, topic_name, partition_id, kafka_endpoint_id, region, cloud_provider		Return the consumer lag on a partition with the given partition_id.
list_kafka_consumer_lags	select	cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider		Return a list of consumer lags of the consumers belonging to the specified consumer group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloud_provider	string	Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
consumer_group_id	string	The consumer group ID. (example: consumer-group-1)
kafka_endpoint_id	string	Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)
partition_id	integer	The partition ID. (example: 0)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)
topic_name	string	The topic name. (example: topic-1)

SELECT examples

get_kafka_consumer_lag

Return the consumer lag on a partition with the given partition_id.

SELECT
client_id,
cluster_id,
consumer_group_id,
consumer_id,
instance_id,
partition_id,
topic_name,
current_offset,
kind,
lag,
log_end_offset,
metadata
FROM confluent.kafka.consumers_lags
WHERE cluster_id = '{{ cluster_id }}' -- required
AND consumer_group_id = '{{ consumer_group_id }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND partition_id = '{{ partition_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_consumer_lags

Return a list of consumer lags of the consumers belonging to the
specified consumer group.

SELECT
client_id,
cluster_id,
consumer_group_id,
consumer_id,
instance_id,
partition_id,
topic_name,
current_offset,
kind,
lag,
log_end_offset,
metadata
FROM confluent.kafka.consumers_lags
WHERE cluster_id = '{{ cluster_id }}' -- required
AND consumer_group_id = '{{ consumer_group_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;