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, Closeable, AutoCloseable, Configurable, MetricsReporter, Reconfigurable

@Internal
public class ConsumerKafkaMetricsReporter
extends AbstractKafkaMetricsReporter

A MetricsReporter class for consumer metrics.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARTITION_TAG

Fields inherited from class AbstractKafkaMetricsReporter

CLIENT_ID_TAG, METRIC_NAME_STYLE_CONFIG, NODE_ID_TAG, TOPIC_TAG

Constructor Summary

Constructors

Constructor	Description
ConsumerKafkaMetricsReporter()

Method Summary

Modifier and Type	Method	Description
void	close()	Method to close bean.
protected Set<String>	getIncludedTags()	The tags to include in the gauge.
protected String	getMetricName(KafkaMetric metric)	Resolve the exported metric name for the supplied Kafka metric.
protected String	getMetricPrefix()	Abstract method to implement with the metric prefix for the reporter.

Methods inherited from class AbstractKafkaMetricsReporter

bindTo, configure, getMetricNameStyle, getMicrometerMetricName, init, isClientCountMetric, metricChange, metricRemoval

Methods inherited from class Object

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

Methods inherited from interface MetricsReporter

contextChange, reconfigurableConfigs, reconfigure, validateReconfiguration

Field Details

PARTITION_TAG

public static final String PARTITION_TAG

See Also:

• Constant Field Values

Constructor Details

ConsumerKafkaMetricsReporter

public ConsumerKafkaMetricsReporter()

Method Details

getMetricPrefix

protected String getMetricPrefix()

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

Specified by:

getMetricPrefix in class AbstractKafkaMetricsReporter

Returns:

prefix name

getMetricName

protected String getMetricName(KafkaMetric metric)

Description copied from class: AbstractKafkaMetricsReporter

Resolve the exported metric name for the supplied Kafka metric.

Overrides:

getMetricName in class AbstractKafkaMetricsReporter

Parameters:

metric - The Kafka metric

Returns:

The metric name to register with Micrometer

getIncludedTags

protected Set<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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface MetricsReporter

Overrides:

close in class AbstractKafkaMetricsReporter