Package org.springframework.kafka.core

Class MicrometerProducerListener<K,V>

java.lang.Object

org.springframework.kafka.core.KafkaMetricsSupport<org.apache.kafka.clients.producer.Producer<K,V>>

org.springframework.kafka.core.MicrometerProducerListener<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

ProducerFactory.Listener<K,V>

public class MicrometerProducerListener<K,V>
extends KafkaMetricsSupport<org.apache.kafka.clients.producer.Producer<K,V>>
implements ProducerFactory.Listener<K,V>

A producer factory listener that manages KafkaClientMetrics.

Since:

2.5

Author:

Gary Russell, Artem Bilan

Field Summary

Fields inherited from class org.springframework.kafka.core.KafkaMetricsSupport

meterRegistry, scheduler, tags

Constructor Summary

Constructors

Constructor	Description
MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Construct an instance with the provided registry.
MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry, List<io.micrometer.core.instrument.Tag> tags)	Construct an instance with the provided registry and tags.
MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry, List<io.micrometer.core.instrument.Tag> tags, TaskScheduler taskScheduler)	Construct an instance with the provided registry, tags and task scheduler.
MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry, TaskScheduler taskScheduler)	Construct an instance with the provided registry and task scheduler.

Method Summary

Modifier and Type	Method	Description
void	producerAdded(String id, org.apache.kafka.clients.producer.Producer<K,V> producer)	A new producer was created.
void	producerRemoved(String id, org.apache.kafka.clients.producer.Producer<K,V> producer)	An existing producer was removed.

Methods inherited from class org.springframework.kafka.core.KafkaMetricsSupport

bindClient, createClientMetrics, unbindClient

Methods inherited from class java.lang.Object

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

Constructor Details

MicrometerProducerListener

public MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Construct an instance with the provided registry.

Parameters:

meterRegistry - the registry.

MicrometerProducerListener

public MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry,
 TaskScheduler taskScheduler)

Construct an instance with the provided registry and task scheduler.

Parameters:

meterRegistry - the registry.

taskScheduler - the task scheduler.

Since:

3.3

MicrometerProducerListener

public MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry,
 List<io.micrometer.core.instrument.Tag> tags)

Construct an instance with the provided registry and tags.

Parameters:

meterRegistry - the registry.

tags - the tags.

MicrometerProducerListener

public MicrometerProducerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry,
 List<io.micrometer.core.instrument.Tag> tags,
 TaskScheduler taskScheduler)

Construct an instance with the provided registry, tags and task scheduler.

Parameters:

meterRegistry - the registry.

tags - the tags.

taskScheduler - the task scheduler.

Since:

3.3

Method Details

producerAdded

public void producerAdded(String id,
 org.apache.kafka.clients.producer.Producer<K,V> producer)

Description copied from interface: ProducerFactory.Listener

A new producer was created.

Specified by:

producerAdded in interface ProducerFactory.Listener<K,V>

Parameters:

id - the producer id (factory bean name and client.id separated by a period).

producer - the producer.

producerRemoved

public void producerRemoved(String id,
 org.apache.kafka.clients.producer.Producer<K,V> producer)

Description copied from interface: ProducerFactory.Listener

An existing producer was removed.

Specified by:

producerRemoved in interface ProducerFactory.Listener<K,V>

Parameters:

id - the producer id (factory bean name and client.id separated by a period).

producer - the producer.