Class AbstractKafkaMetricsReporter

java.lang.Object

io.micronaut.configuration.kafka.metrics.AbstractKafkaMetricsReporter

All Implemented Interfaces:

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

Direct Known Subclasses:

ConsumerKafkaMetricsReporter, KafkaStreamsMetricsReporter, ProducerKafkaMetricsReporter

@Internal
public abstract class AbstractKafkaMetricsReporter
extends Object
implements MetricsReporter, io.micrometer.core.instrument.binder.MeterBinder, Closeable

A MetricsReporter that binds metrics to micrometer.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_ID_TAG
static final String	NODE_ID_TAG
static final String	TOPIC_TAG

Constructor Summary

Constructors

Constructor	Description
AbstractKafkaMetricsReporter()

Method Summary

Modifier and Type	Method	Description
void	bindTo(@NonNull io.micrometer.core.instrument.MeterRegistry registry)
void	close()
void	configure(Map<String,?> configs)
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 abstract String	getMetricPrefix()	Abstract method to implement with the metric prefix for the reporter.
void	init(List<KafkaMetric> metrics)
void	metricChange(KafkaMetric metric)
void	metricRemoval(KafkaMetric metric)

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

CLIENT_ID_TAG

public static final String CLIENT_ID_TAG

See Also:

• Constant Field Values

TOPIC_TAG

public static final String TOPIC_TAG

See Also:

• Constant Field Values

NODE_ID_TAG

public static final String NODE_ID_TAG

See Also:

• Constant Field Values

Constructor Details

AbstractKafkaMetricsReporter

public AbstractKafkaMetricsReporter()

Method Details

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(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(Map<String,?> configs)

Specified by:

configure in interface Configurable

close

@PreDestroy
public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface MetricsReporter

getMetricName

protected String getMetricName(KafkaMetric metric)

Resolve the exported metric name for the supplied Kafka metric.

Parameters:

metric - The Kafka metric

Returns:

The metric name to register with Micrometer

getIncludedTags

protected Set<String> getIncludedTags()

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

Returns:

The tags to include

getMetricPrefix

protected abstract String getMetricPrefix()

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

Returns:

prefix name