io.micronaut.configuration.kafka.metrics

Class ConsumerKafkaMetricsReporter

java.lang.Object

io.micronaut.configuration.kafka.metrics.AbstractKafkaMetricsReporter

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 AbstractKafkaMetricsReporter

A MetricsReporter class for consumer metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARTITION_TAG

Fields inherited from class io.micronaut.configuration.kafka.metrics.AbstractKafkaMetricsReporter

CLIENT_ID_TAG, NODE_ID_TAG, TOPIC_TAG

Constructor Summary

Constructors

Constructor and Description
ConsumerKafkaMetricsReporter()

Method Summary

Modifier and Type	Method and Description
void	close() Method to close bean.
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.

Methods inherited from class io.micronaut.configuration.kafka.metrics.AbstractKafkaMetricsReporter

bindTo, configure, init, metricChange, metricRemoval

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

Field Detail

PARTITION_TAG

public static final java.lang.String PARTITION_TAG

See Also:

Constant Field Values

Constructor Detail

ConsumerKafkaMetricsReporter

public ConsumerKafkaMetricsReporter()

Method Detail

getMetricPrefix

protected java.lang.String getMetricPrefix()

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

Specified by:

getMetricPrefix in class AbstractKafkaMetricsReporter

Returns:

prefix name

getIncludedTags

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

Description copied from class: AbstractKafkaMetricsReporter

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

Overrides:

getIncludedTags in class AbstractKafkaMetricsReporter

Returns:

The tags to include

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

Overrides:

close in class AbstractKafkaMetricsReporter