io.confluent.telemetry.provider

Class KafkaClientProvider

java.lang.Object

io.confluent.telemetry.provider.KafkaClientProvider

All Implemented Interfaces:

Provider, org.apache.kafka.common.Configurable

public class KafkaClientProvider
extends Object
implements Provider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_NAMESPACE
static String	CONSUMER_NAMESPACE
static String	DOMAIN
static String	LABEL_CLIENT_ID
static String	PRODUCER_NAMESPACE

Fields inherited from interface io.confluent.telemetry.provider.Provider

EXCLUDE_ALL

Constructor Summary

Constructors

Constructor and Description
KafkaClientProvider()

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,?> configs)
void	contextChange(org.apache.kafka.common.metrics.MetricsContext metricsContext) Sets the metrics labels for the service or library exposing metrics.
String	domain() Domain of the active provider.
List<MetricsCollector>	extraCollectors(Context ctx) The collector for Kafka Metrics library is enabled by default.
List<String>	metricsIncludeRegexDefault() The metrics include regular expression list used as a default value for this provider.
io.opentelemetry.proto.resource.v1.Resource	resource() The resource for this provider.
boolean	validate(org.apache.kafka.common.metrics.MetricsContext metricsContext, Map<String,?> config) Validate that all the data required for generating correct metrics is present.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.confluent.telemetry.provider.Provider

configInclude

Field Detail

DOMAIN

public static final String DOMAIN

See Also:

Constant Field Values

LABEL_CLIENT_ID

public static final String LABEL_CLIENT_ID

See Also:

Constant Field Values

ADMIN_NAMESPACE

public static final String ADMIN_NAMESPACE

See Also:

Constant Field Values

CONSUMER_NAMESPACE

public static final String CONSUMER_NAMESPACE

See Also:

Constant Field Values

PRODUCER_NAMESPACE

public static final String PRODUCER_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

KafkaClientProvider

public KafkaClientProvider()

Method Detail

configure

public void configure(Map<String,?> configs)

Specified by:

configure in interface org.apache.kafka.common.Configurable

validate

public boolean validate(org.apache.kafka.common.metrics.MetricsContext metricsContext,
                        Map<String,?> config)

Description copied from interface: Provider

Validate that all the data required for generating correct metrics is present. The provider will be disabled if validation fails.

Specified by:

validate in interface Provider

Parameters:

metricsContext - MetricsContext

Returns:

false if all the data required for generating correct metrics is missing, true otherwise.

contextChange

public void contextChange(org.apache.kafka.common.metrics.MetricsContext metricsContext)

Description copied from interface: Provider

Sets the metrics labels for the service or library exposing metrics. This will be called before MetricsReporter.init(List) and may be called anytime after that.

Specified by:

contextChange in interface Provider

Parameters:

metricsContext - MetricsContext

resource

public io.opentelemetry.proto.resource.v1.Resource resource()

Description copied from interface: Provider

The resource for this provider.

Specified by:

resource in interface Provider

Returns:

A fully formed Resource will all the tags.

domain

public String domain()

Description copied from interface: Provider

Domain of the active provider. This is used by other parts of the reporter.

Specified by:

domain in interface Provider

Returns:

Domain in string format.

extraCollectors

public List<MetricsCollector> extraCollectors(Context ctx)

Description copied from interface: Provider

The collector for Kafka Metrics library is enabled by default. If you need any more, add them here.

Specified by:

extraCollectors in interface Provider

Parameters:

ctx - Context

Returns:

List of extra collectors

metricsIncludeRegexDefault

public List<String> metricsIncludeRegexDefault()

Description copied from interface: Provider

The metrics include regular expression list used as a default value for this provider. This list will be joined as following '.*.*|.*.*' to form a union.

Specified by:

metricsIncludeRegexDefault in interface Provider

Returns:

a list of regular expressions to match metric names