Skip to main content
Quick navigation

Metrics Reference

Console exposes metrics using the Prometheus format for your Kafka resources and Console health that you can scrape and send to your external log management system.

Kafka Metrics Reference

The metrics endpoint is located on /monitoring/metrics of your deployed Console instance. Data points are refreshed every 30 seconds.

Metric NameMetric TypeLabelsDescription
Consumer Group Metrics
kafka_consumergroup_group_laggaugecluster_id, cluster_name, group, topic, partitionAbsolute Lag of the consumer group on this topic-partition
kafka_consumergroup_group_lag_secondsgaugecluster_id, cluster_name, group, topic, partitionLag in seconds of the consumer group on this topic-partition
kafka_consumergroup_group_offsetgaugecluster_id, cluster_name, group, topic, partitionLast commited offset of the consumer group on this topic-partition
Consumer Group Metrics (Aggregated)
kafka_consumergroup_group_max_laggaugecluster_id, cluster_name, groupMax group offset lag
kafka_consumergroup_group_max_lag_secondsgaugecluster_id, cluster_name, groupLag in seconds of the consumer group (all topics)
kafka_consumergroup_group_sum_laggaugecluster_id, cluster_name, groupSum of Absolute Lag of the consumer group (all topics)
kafka_consumergroup_group_topic_sum_laggaugecluster_id, cluster_name, group, topicSum of Absolute Lag of the consumer group on this topic (all partitions)
Kafka Cluster & Broker Metrics
kafka_controller_kafkacontroller_activebrokercountgaugecluster_name, cluster_idNumber of active Brokers on the Kafka cluster
kafka_controller_kafkacontroller_activecontrollercountgaugecluster_name, cluster_idNumber of active Controllers on the Kafka cluster
kafka_controller_kafkacontroller_globalpartitioncountgaugecluster_name, cluster_idTotal number of partitions on the Kafka cluster
kafka_controller_kafkacontroller_offlinepartitionscountgaugecluster_name, cluster_idNumber of Partitions with no active Leader
kafka_server_replicamanager_leadercountgaugecluster_name, cluster_id, broker_id, broker_hostNumber of Partition Leaders on this Broker
kafka_server_replicamanager_partitioncountgaugecluster_name, cluster_id, broker_id, broker_hostNumber of Partitions on this Broker
kafka_server_replicamanager_underminisrpartitioncountgaugecluster_name, cluster_idNumber of Partitions with replicas that don't meet their minimum ISR
kafka_server_replicamanager_underreplicatedpartitionsgaugecluster_name, cluster_idNumber of Partitions with replicas that don't meet their replication factor
Kafka Connect Metrics
kafka_connect_failed_tasksgaugecluster_name, cluster_id, connect_cluster_id, connectorNumber of Failed tasks for this Connector
kafka_connect_total_tasksgaugecluster_name, cluster_id, connect_cluster_id, connectorTotal number of tasks configured for this Connector
Kafka Topic & Partition Metrics
kafka_cluster_partition_underminisrgaugecluster_name, cluster_id, topic, partition1 when the partition is under min ISR
kafka_cluster_partition_underreplicatedgaugecluster_name, cluster_id, topic, partition1 when the partition is under-replicated
kafka_partition_earliest_offsetgaugecluster_id, cluster_name, topic, partitionEarliest offset of the current topic-partition
kafka_partition_latest_offsetgaugecluster_id, cluster_name, topic, partitionLatest offset of the current topic-partition
Others
kafka_consumergroup_poll_time_msgaugecluster_id, cluster_nameGroup time poll time
kafka_controller_controllerstats_uncleanleaderelectionspersec_createdgaugecluster_name, cluster_idCounter for kafka_controller_controllerstats_uncleanleaderelectionspersec metric
kafka_controller_controllerstats_uncleanleaderelectionspersec_totalcountercluster_name, cluster_idCounter for kafka_controller_controllerstats_uncleanleaderelectionspersec metric
kafka_log_log_sizegaugebroker_host, partition, broker_id, topic, cluster_name, cluster_idSize in bytes of the current topic-partition
info

Note that the label cluster_name is obsolete and will be removed soon. You should use cluster_id instead.

Console Reference

The metrics endpoint is located on /api/metrics of your deployed Console instance.

Metric NameMetric TypeLabelsDescription
Console API
console_api_request_activegaugepath, method
console_api_request_duration_secondshistogram
console_api_request_duration_seconds_countpath, method, status, phase
console_api_request_duration_seconds_maxpath, method, status, phase
console_api_request_duration_seconds_minpath, method, status, phase
console_api_request_duration_seconds_sumpath, method, status, phase
console_api_request_totalcounterpath, method, status
Console caches
console_cache_cluster_reachable_hits_totalcounterNumber of cache hits for cluster_reachable
console_cache_cluster_reachable_misses_totalcounterNumber of cache miss for cluster_reachable
console_cache_cluster_reachable_sizegaugeTotal cache size for cluster_reachable
console_cache_kafka_admin_hits_totalcounterNumber of cache hits for kafka_admin
console_cache_kafka_admin_misses_totalcounterNumber of cache miss for kafka_admin
console_cache_kafka_admin_sizegaugeTotal cache size for kafka_admin
console_cache_schema_registry_clients_hits_totalcounterNumber of cache hits for schema_registry_clients
console_cache_schema_registry_clients_misses_totalcounterNumber of cache miss for schema_registry_clients
console_cache_schema_registry_clients_sizegaugeTotal cache size for schema_registry_clients
Kafka cluster indexing
console_indexer_kafka_cluster_durationhistogramDuration in milliseconds to index Kafka cluster
console_indexer_kafka_cluster_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_cluster_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_cluster_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_cluster_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_cluster_failed_countgaugeNumber of failed Kafka cluster indexing tasks
console_indexer_kafka_cluster_skipped_countgaugeNumber of skipped Kafka cluster indexing tasks
console_indexer_kafka_cluster_succeeded_countgaugeNumber of succeeded Kafka cluster indexing tasks
console_indexer_kafka_cluster_timeout_countgaugeNumber of timed out Kafka cluster indexing tasks
console_indexer_kafka_describe_topics_durationhistogramDuration in milliseconds to describes all topics per Kafka cluster
console_indexer_kafka_describe_topics_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_describe_topics_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_describe_topics_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_describe_topics_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_get_consumers_groups_durationhistogramDuration in milliseconds to get all consumers groups state per Kafka cluster
console_indexer_kafka_get_consumers_groups_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_get_consumers_groups_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_get_consumers_groups_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_get_consumers_groups_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_get_deployed_connectors_durationhistogramDuration in milliseconds to list all deployed connector per Kafka cluster
console_indexer_kafka_get_deployed_connectors_duration_counttime_unit, technical_id, cluster_type, kafka_connect
console_indexer_kafka_get_deployed_connectors_duration_maxtime_unit, technical_id, cluster_type, kafka_connect
console_indexer_kafka_get_deployed_connectors_duration_mintime_unit, technical_id, cluster_type, kafka_connect
console_indexer_kafka_get_deployed_connectors_duration_sumtime_unit, technical_id, cluster_type, kafka_connect
console_indexer_kafka_get_topics_configs_durationhistogramDuration in milliseconds to get all topics topics configuration per Kafka cluster
console_indexer_kafka_get_topics_configs_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_configs_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_configs_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_configs_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_partitions_durationhistogramDuration in milliseconds to get all topics partitions state per Kafka cluster
console_indexer_kafka_get_topics_partitions_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_partitions_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_partitions_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_get_topics_partitions_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_init_cluster_connection_durationhistogramDuration in milliseconds to initialize the connection per Kafka cluster
console_indexer_kafka_init_cluster_connection_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_init_cluster_connection_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_init_cluster_connection_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_init_cluster_connection_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_list_topics_durationhistogramDuration in milliseconds to list topics per Kafka cluster
console_indexer_kafka_list_topics_duration_counttime_unit, technical_id, cluster_type
console_indexer_kafka_list_topics_duration_maxtime_unit, technical_id, cluster_type
console_indexer_kafka_list_topics_duration_mintime_unit, technical_id, cluster_type
console_indexer_kafka_list_topics_duration_sumtime_unit, technical_id, cluster_type
console_indexer_kafka_total_clusters_countgaugeTotal number of Kafka cluster
console_indexer_kafka_total_durationhistogramTotal duration in milliseconds to index Kafka cluster
console_indexer_kafka_total_duration_counttime_unit
console_indexer_kafka_total_duration_maxtime_unit
console_indexer_kafka_total_duration_mintime_unit
console_indexer_kafka_total_duration_sumtime_unit
Kafka connect indexing
console_indexer_kafka_connect_cluster_failed_countgaugeNumber of failed Kafka Connect server indexing tasks
console_indexer_kafka_connect_cluster_skipped_countgaugeNumber of skipped Kafka Connect server indexing tasks
console_indexer_kafka_connect_cluster_succeeded_countgaugeNumber of succeeded Kafka Connect server indexing tasks
console_indexer_kafka_connect_cluster_timeout_countgaugeNumber of timed out Kafka Connect server indexing tasks
console_indexer_kafka_connect_total_clusters_countgaugeTotal number of Kafka Connect server
console_indexer_kafka_connect_total_durationhistogramTotal duration in milliseconds to index Kafka Connect server
console_indexer_kafka_connect_total_duration_counttime_unit
console_indexer_kafka_connect_total_duration_maxtime_unit
console_indexer_kafka_connect_total_duration_mintime_unit
console_indexer_kafka_connect_total_duration_sumtime_unit
Schema registry indexing
console_indexer_schema_registry_cluster_failed_countgaugeNumber of failed Schema Registry server indexing tasks
console_indexer_schema_registry_cluster_skipped_countgaugeNumber of skipped Schema Registry server indexing tasks
console_indexer_schema_registry_cluster_succeeded_countgaugeNumber of succeeded Schema Registry server indexing tasks
console_indexer_schema_registry_cluster_timeout_countgaugeNumber of timed out Schema Registry server indexing tasks
console_indexer_schema_registry_total_clusters_countgaugeTotal number of Schema Registry server
console_indexer_schema_registry_total_durationhistogramTotal duration in milliseconds to index Schema Registry server
console_indexer_schema_registry_total_duration_counttime_unit
console_indexer_schema_registry_total_duration_maxtime_unit
console_indexer_schema_registry_total_duration_mintime_unit
console_indexer_schema_registry_total_duration_sumtime_unit