Class KafkaStreamsMicrometerListener
java.lang.Object
org.springframework.kafka.core.KafkaMetricsSupport<org.apache.kafka.streams.KafkaStreams>
org.springframework.kafka.streams.KafkaStreamsMicrometerListener
- All Implemented Interfaces:
StreamsBuilderFactoryBean.Listener
public class KafkaStreamsMicrometerListener
extends KafkaMetricsSupport<org.apache.kafka.streams.KafkaStreams>
implements StreamsBuilderFactoryBean.Listener
Creates a
KafkaStreamsMetrics
for the KafkaStreams
.- Since:
- 2.5.3
- Author:
- Gary Russell, Artem Bilan
-
Field Summary
Fields inherited from class org.springframework.kafka.core.KafkaMetricsSupport
meterRegistry, scheduler, tags
-
Constructor Summary
ConstructorsConstructorDescriptionKafkaStreamsMicrometerListener
(io.micrometer.core.instrument.MeterRegistry meterRegistry) Construct an instance with the provided registry.KafkaStreamsMicrometerListener
(io.micrometer.core.instrument.MeterRegistry meterRegistry, List<io.micrometer.core.instrument.Tag> tags) Construct an instance with the provided registry and tags.KafkaStreamsMicrometerListener
(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.KafkaStreamsMicrometerListener
(io.micrometer.core.instrument.MeterRegistry meterRegistry, TaskScheduler taskScheduler) Construct an instance with the provided registry and task scheduler. -
Method Summary
Modifier and TypeMethodDescriptionprotected io.micrometer.core.instrument.binder.MeterBinder
createClientMetrics
(org.apache.kafka.streams.KafkaStreams client, List<io.micrometer.core.instrument.Tag> tags) Create aio.micrometer.core.instrument.binder.kafka.KafkaMetrics
instance for the provided Kafka client and metric tags.void
streamsAdded
(String id, org.apache.kafka.streams.KafkaStreams kafkaStreams) A newKafkaStreams
was created.void
streamsRemoved
(String id, org.apache.kafka.streams.KafkaStreams streams) An existingKafkaStreams
was removed.Methods inherited from class org.springframework.kafka.core.KafkaMetricsSupport
bindClient, unbindClient
-
Constructor Details
-
KafkaStreamsMicrometerListener
public KafkaStreamsMicrometerListener(io.micrometer.core.instrument.MeterRegistry meterRegistry) Construct an instance with the provided registry.- Parameters:
meterRegistry
- the registry.
-
KafkaStreamsMicrometerListener
public KafkaStreamsMicrometerListener(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
-
KafkaStreamsMicrometerListener
public KafkaStreamsMicrometerListener(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.
-
KafkaStreamsMicrometerListener
public KafkaStreamsMicrometerListener(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
-
streamsAdded
Description copied from interface:StreamsBuilderFactoryBean.Listener
A newKafkaStreams
was created.- Specified by:
streamsAdded
in interfaceStreamsBuilderFactoryBean.Listener
- Parameters:
id
- the streams id (factory bean name).kafkaStreams
- the streams;
-
createClientMetrics
protected io.micrometer.core.instrument.binder.MeterBinder createClientMetrics(org.apache.kafka.streams.KafkaStreams client, List<io.micrometer.core.instrument.Tag> tags) Description copied from class:KafkaMetricsSupport
Create aio.micrometer.core.instrument.binder.kafka.KafkaMetrics
instance for the provided Kafka client and metric tags. By default, this factory is aware ofConsumer
,Producer
andAdminClient
types. For other use-case this method can be overridden.- Overrides:
createClientMetrics
in classKafkaMetricsSupport<org.apache.kafka.streams.KafkaStreams>
- Parameters:
client
- the client to create aio.micrometer.core.instrument.binder.kafka.KafkaMetrics
instance for.tags
- the tags for theio.micrometer.core.instrument.binder.kafka.KafkaMetrics
.- Returns:
- the
io.micrometer.core.instrument.binder.kafka.KafkaMetrics
.
-
streamsRemoved
Description copied from interface:StreamsBuilderFactoryBean.Listener
An existingKafkaStreams
was removed.- Specified by:
streamsRemoved
in interfaceStreamsBuilderFactoryBean.Listener
- Parameters:
id
- the streams id (factory bean name).streams
- the streams;
-