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

Class KafkaStreamsMetrics

java.lang.Object
io.micrometer.core.instrument.binder.kafka.KafkaStreamsMetrics
All Implemented Interfaces:
MeterBinder, java.lang.AutoCloseable
@Incubating(since="1.4.0")
@NonNullApi
@NonNullFields
public class KafkaStreamsMetrics
extends java.lang.Object
Kafka Streams 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
    KafkaStreamsMetrics​(org.apache.kafka.streams.KafkaStreams kafkaStreams)
    KafkaStreams metrics binder
    KafkaStreamsMetrics​(org.apache.kafka.streams.KafkaStreams kafkaStreams, java.lang.Iterable<Tag> tags)
    KafkaStreams 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

    • KafkaStreamsMetrics

      public KafkaStreamsMetrics​(org.apache.kafka.streams.KafkaStreams kafkaStreams, java.lang.Iterable<Tag> tags)
      KafkaStreams metrics binder
      Parameters:
      kafkaStreams - instance to be instrumented
      tags - additional tags

    • KafkaStreamsMetrics

      public KafkaStreamsMetrics​(org.apache.kafka.streams.KafkaStreams kafkaStreams)
      KafkaStreams metrics binder
      Parameters:
      kafkaStreams - 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