io.micronaut.configuration.kafka.metrics

Class AbstractKafkaMetricsReporter

java.lang.Object

io.micronaut.configuration.kafka.metrics.AbstractKafkaMetricsReporter

All Implemented Interfaces:

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

Direct Known Subclasses:

ConsumerKafkaMetricsReporter, KafkaStreamsMetricsReporter, ProducerKafkaMetricsReporter

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

A MetricsReporter that binds metrics to micrometer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_ID_TAG
static java.lang.String	NODE_ID_TAG
static java.lang.String	TOPIC_TAG

Constructor Summary

Constructors

Constructor and Description
AbstractKafkaMetricsReporter()

Method Summary

Modifier and Type	Method and Description
void	bindTo(io.micrometer.core.instrument.MeterRegistry registry)
void	close()
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 abstract 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

Field Detail

CLIENT_ID_TAG

public static final java.lang.String CLIENT_ID_TAG

See Also:

Constant Field Values

TOPIC_TAG

public static final java.lang.String TOPIC_TAG

See Also:

Constant Field Values

NODE_ID_TAG

public static final java.lang.String NODE_ID_TAG

See Also:

Constant Field Values

Constructor Detail

AbstractKafkaMetricsReporter

public AbstractKafkaMetricsReporter()

Method Detail

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

close

@PreDestroy
public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface MetricsReporter

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

getMetricPrefix

protected abstract java.lang.String getMetricPrefix()

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

Returns:

prefix name