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

Class KafkaClientMetrics

java.lang.Object

io.micrometer.core.instrument.binder.kafka.KafkaClientMetrics

All Implemented Interfaces:

MeterBinder, AutoCloseable

@Incubating(since="1.4.0")
@NonNullApi
@NonNullFields
public class KafkaClientMetrics
extends Object

Kafka Client metrics binder.

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)

Note: the AutoCloseable.close() method should be called when the application shuts down to shut down the internal metrics-refresh scheduler (when not externally managed) and to remove the meters this binder registered.

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, Iterable<Tag> tags)	Kafka AdminClient metrics binder
KafkaClientMetrics(org.apache.kafka.clients.admin.AdminClient adminClient, Iterable<Tag> tags, ScheduledExecutorService scheduler)	Kafka AdminClient metrics binder.
KafkaClientMetrics(org.apache.kafka.clients.consumer.Consumer<?,?> kafkaConsumer)	Kafka Consumer metrics binder
KafkaClientMetrics(org.apache.kafka.clients.consumer.Consumer<?,?> kafkaConsumer, Iterable<Tag> tags)	Kafka Consumer metrics binder
KafkaClientMetrics(org.apache.kafka.clients.consumer.Consumer<?,?> kafkaConsumer, Iterable<Tag> tags, ScheduledExecutorService scheduler)	Kafka Consumer metrics binder.
KafkaClientMetrics(org.apache.kafka.clients.producer.Producer<?,?> kafkaProducer)	Kafka Producer metrics binder
KafkaClientMetrics(org.apache.kafka.clients.producer.Producer<?,?> kafkaProducer, Iterable<Tag> tags)	Kafka Producer metrics binder
KafkaClientMetrics(org.apache.kafka.clients.producer.Producer<?,?> kafkaProducer, Iterable<Tag> tags, ScheduledExecutorService scheduler)	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,
 Iterable<Tag> tags,
 ScheduledExecutorService scheduler)

Kafka Producer metrics binder. The lifecycle of the custom scheduler passed is the responsibility of the caller. It will not be shut down when this instance is closed. A scheduler can be shared among multiple instances of KafkaClientMetrics to reduce resource usage by reducing the number of threads if there will be many instances.

Parameters:

kafkaProducer - producer instance to be instrumented

tags - additional tags

scheduler - custom scheduler to check and bind metrics

Since:

1.14.0

KafkaClientMetrics

public KafkaClientMetrics(org.apache.kafka.clients.producer.Producer<?,?> kafkaProducer,
 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,
 Iterable<Tag> tags,
 ScheduledExecutorService scheduler)

Kafka Consumer metrics binder. The lifecycle of the custom scheduler passed is the responsibility of the caller. It will not be shut down when this instance is closed. A scheduler can be shared among multiple instances of KafkaClientMetrics to reduce resource usage by reducing the number of threads if there will be many instances.

Parameters:

kafkaConsumer - consumer instance to be instrumented

tags - additional tags

scheduler - custom scheduler to check and bind metrics

Since:

1.14.0

KafkaClientMetrics

public KafkaClientMetrics(org.apache.kafka.clients.consumer.Consumer<?,?> kafkaConsumer,
 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,
 Iterable<Tag> tags,
 ScheduledExecutorService scheduler)

Kafka AdminClient metrics binder. The lifecycle of the custom scheduler passed is the responsibility of the caller. It will not be shut down when this instance is closed. A scheduler can be shared among multiple instances of KafkaClientMetrics to reduce resource usage by reducing the number of threads if there will be many instances.

Parameters:

adminClient - instance to be instrumented

tags - additional tags

scheduler - custom scheduler to check and bind metrics

Since:

1.14.0

KafkaClientMetrics

public KafkaClientMetrics(org.apache.kafka.clients.admin.AdminClient adminClient,
 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 AutoCloseable