io.micronaut.configuration.kafka.metrics.builder

Class KafkaMetricMeterTypeBuilder

java.lang.Object

io.micronaut.configuration.kafka.metrics.builder.KafkaMetricMeterTypeBuilder

@Internal
public class KafkaMetricMeterTypeBuilder
extends java.lang.Object

A builder class for constructing a typed kafka meter. Will lookup the type in KafkaMetricMeterTypeRegistry. Supported meter types can be seen in MeterType.

Since:

1.4.1

Constructor Summary

Constructors

Constructor and Description
KafkaMetricMeterTypeBuilder()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<io.micrometer.core.instrument.Meter>	build() Build and register a typed meter.
KafkaMetricMeterTypeBuilder	metric(org.apache.kafka.common.metrics.KafkaMetric kafkaMetric) Builder method for setting kafka metric.
KafkaMetricMeterTypeBuilder	name(java.lang.String name) Builder method for setting metric name.
static KafkaMetricMeterTypeBuilder	newBuilder() Method for creating a new builder class.
KafkaMetricMeterTypeBuilder	prefix(java.lang.String prefix) Builder method for setting metric prefix.
KafkaMetricMeterTypeBuilder	registry(io.micrometer.core.instrument.MeterRegistry meterRegistry) Builder method for setting a MeterRegistry.
KafkaMetricMeterTypeBuilder	tagFunction(java.util.function.Function<org.apache.kafka.common.MetricName,java.util.List<io.micrometer.core.instrument.Tag>> tagFunction) Builder method for setting function to get tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

KafkaMetricMeterTypeBuilder

public KafkaMetricMeterTypeBuilder()

Method Detail

newBuilder

public static KafkaMetricMeterTypeBuilder newBuilder()

Method for creating a new builder class.

Returns:

builder class

metric

public KafkaMetricMeterTypeBuilder metric(org.apache.kafka.common.metrics.KafkaMetric kafkaMetric)

Builder method for setting kafka metric.

Parameters:

kafkaMetric - kafka metric class

Returns:

builder class

prefix

public KafkaMetricMeterTypeBuilder prefix(java.lang.String prefix)

Builder method for setting metric prefix.

Parameters:

prefix - Metric prefix

Returns:

builder class

name

public KafkaMetricMeterTypeBuilder name(java.lang.String name)

Builder method for setting metric name. This is optional and will b derived form metric if not provided.

Parameters:

name - Metric name

Returns:

builder class

tagFunction

public KafkaMetricMeterTypeBuilder tagFunction(java.util.function.Function<org.apache.kafka.common.MetricName,java.util.List<io.micrometer.core.instrument.Tag>> tagFunction)

Builder method for setting function to get tags. This is Function due to the use of abstract method for getting tags details in AbstractKafkaMetricsReporter.

Parameters:

tagFunction - Function to provide tags

Returns:

builder class

registry

public KafkaMetricMeterTypeBuilder registry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Builder method for setting a MeterRegistry.

Parameters:

meterRegistry - The meter registry

Returns:

builder class

build

public java.util.Optional<io.micrometer.core.instrument.Meter> build()

Build and register a typed meter.

Returns:

Optional type of Meter