Package io.micrometer.core.instrument.binder.kafka

Class KafkaClientMetrics

java.lang.Object
io.micrometer.core.instrument.binder.kafka.KafkaClientMetrics
All Implemented Interfaces:
MeterBinder, java.lang.AutoCloseable
@Incubating(since="1.4.0")
@NonNullApi
@NonNullFields
public class KafkaClientMetrics
extends java.lang.Object
Kafka Client metrics binder. This should be closed on application shutdown to clean up resources.

It is based on the Kafka client's metrics() method returning a Metric map.

Meter names have the following convention: kafka.(metric_group).(metric_name)

Since:
1.4.0
See Also:
Kakfa monitoring documentation

  • Constructor Summary

    Constructors
    Constructor Description
    KafkaClientMetrics​(org.apache.kafka.clients.admin.AdminClient adminClient)
    Kafka AdminClient metrics binder
    KafkaClientMetrics​(org.apache.kafka.clients.admin.AdminClient adminClient, java.lang.Iterable<Tag> tags)
    Kafka AdminClient metrics binder
    KafkaClientMetrics​(org.apache.kafka.clients.consumer.Consumer<?,​?> kafkaConsumer)
    Kafka Consumer metrics binder
    KafkaClientMetrics​(org.apache.kafka.clients.consumer.Consumer<?,​?> kafkaConsumer, java.lang.Iterable<Tag> tags)
    Kafka Consumer metrics binder
    KafkaClientMetrics​(org.apache.kafka.clients.producer.Producer<?,​?> kafkaProducer)
    Kafka Producer metrics binder
    KafkaClientMetrics​(org.apache.kafka.clients.producer.Producer<?,​?> kafkaProducer, java.lang.Iterable<Tag> tags)
    Kafka Producer metrics binder

  • Method Summary

    Modifier and Type Method Description
    void bindTo​(MeterRegistry registry)  
    void close()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.producer.Producer<?,​?> kafkaProducer, java.lang.Iterable<Tag> tags)
      Kafka Producer metrics binder
      Parameters:
      kafkaProducer - producer instance to be instrumented
      tags - additional tags

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.producer.Producer<?,​?> kafkaProducer)
      Kafka Producer metrics binder
      Parameters:
      kafkaProducer - producer instance to be instrumented

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.consumer.Consumer<?,​?> kafkaConsumer, java.lang.Iterable<Tag> tags)
      Kafka Consumer metrics binder
      Parameters:
      kafkaConsumer - consumer instance to be instrumented
      tags - additional tags

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.consumer.Consumer<?,​?> kafkaConsumer)
      Kafka Consumer metrics binder
      Parameters:
      kafkaConsumer - consumer instance to be instrumented

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.admin.AdminClient adminClient, java.lang.Iterable<Tag> tags)
      Kafka AdminClient metrics binder
      Parameters:
      adminClient - instance to be instrumented
      tags - additional tags

    • KafkaClientMetrics

      public KafkaClientMetrics​(org.apache.kafka.clients.admin.AdminClient adminClient)
      Kafka AdminClient metrics binder
      Parameters:
      adminClient - instance to be instrumented

  • Method Details

    • bindTo

      public void bindTo​(MeterRegistry registry)
      Specified by:
      bindTo in interface MeterBinder

    • close

      public void close()
      Specified by:
      close in interface java.lang.AutoCloseable