io.micronaut.configuration.kafka.metrics

Class ConsumerKafkaMetricsReporter

java.lang.Object

io.micronaut.configuration.kafka.metrics.ConsumerKafkaMetricsReporter

All Implemented Interfaces:

io.micrometer.core.instrument.binder.MeterBinder, java.io.Closeable, java.lang.AutoCloseable, Configurable, MetricsReporter, Reconfigurable

@Internal
public class ConsumerKafkaMetricsReporter
extends java.lang.Object

A MetricsReporter class for consumer metrics.

Constructor Summary

Constructors

Constructor and Description
ConsumerKafkaMetricsReporter()

Method Summary

Modifier and Type	Method and Description
void	bindTo(io.micrometer.core.instrument.MeterRegistry registry)
void	close() Method to close bean.
void	configure(java.util.Map<java.lang.String,?> configs)
protected java.util.Set<java.lang.String>	getIncludedTags() The tags to include in the gauge.
protected java.lang.String	getMetricPrefix() Abstract method to implement with the metric prefix for the reporter.
void	init(java.util.List<KafkaMetric> metrics)
void	metricChange(KafkaMetric metric)
void	metricRemoval(KafkaMetric metric)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.common.metrics.MetricsReporter

contextChange, reconfigurableConfigs, reconfigure, validateReconfiguration

Constructor Detail

ConsumerKafkaMetricsReporter

public ConsumerKafkaMetricsReporter()

Method Detail

getMetricPrefix

protected java.lang.String getMetricPrefix()

Abstract method to implement with the metric prefix for the reporter.

Returns:

prefix name

close

@PreDestroy
public void close()

Method to close bean. This must remain here for metrics to continue to function correctly for some reason?!.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface MetricsReporter

bindTo

public void bindTo(@NonNull
                   io.micrometer.core.instrument.MeterRegistry registry)

Specified by:

bindTo in interface io.micrometer.core.instrument.binder.MeterBinder

init

public void init(java.util.List<KafkaMetric> metrics)

Specified by:

init in interface MetricsReporter

metricChange

public void metricChange(KafkaMetric metric)

Specified by:

metricChange in interface MetricsReporter

metricRemoval

public void metricRemoval(KafkaMetric metric)

Specified by:

metricRemoval in interface MetricsReporter

configure

public void configure(java.util.Map<java.lang.String,?> configs)

Specified by:

configure in interface Configurable

getIncludedTags

protected java.util.Set<java.lang.String> getIncludedTags()

The tags to include in the gauge. Defaults to just the client-id.

Returns:

The tags to include