io.confluent.telemetry.provider

Class KafkaServerProvider

java.lang.Object

io.confluent.telemetry.provider.KafkaServerProvider

All Implemented Interfaces:

Provider, org.apache.kafka.common.Configurable

public class KafkaServerProvider
extends Object
implements Provider

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BROKER_METRICS_INCLUDE_REGEX
static String	DEFAULT_SECURITY_METRICS_INCLUDE_REGEX
static String	LABEL_BROKER_ID
static String	LABEL_BROKER_RACK
static String	LABEL_CELL_ID
static String	LABEL_CLUSTER_ID
static String	LABEL_PROCESS_BROKER
static String	LABEL_PROCESS_CONTROLLER
static String	LABEL_PROCESS_ROLES
static String	NAMESPACE

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

EXCLUDE_ALL

Constructor Summary

Constructors

Constructor and Description
KafkaServerProvider()

Method Summary

Modifier and Type	Method and Description
Predicate<String>	configInclude() Include list for config
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

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

Field Detail

DEFAULT_SECURITY_METRICS_INCLUDE_REGEX

public static final String DEFAULT_SECURITY_METRICS_INCLUDE_REGEX

See Also:

Constant Field Values

DEFAULT_BROKER_METRICS_INCLUDE_REGEX

public static final String DEFAULT_BROKER_METRICS_INCLUDE_REGEX

See Also:

Constant Field Values

LABEL_CLUSTER_ID

public static final String LABEL_CLUSTER_ID

See Also:

Constant Field Values

LABEL_BROKER_ID

public static final String LABEL_BROKER_ID

See Also:

Constant Field Values

LABEL_BROKER_RACK

public static final String LABEL_BROKER_RACK

See Also:

Constant Field Values

LABEL_CELL_ID

public static final String LABEL_CELL_ID

See Also:

Constant Field Values

LABEL_PROCESS_ROLES

public static final String LABEL_PROCESS_ROLES

See Also:

Constant Field Values

LABEL_PROCESS_BROKER

public static final String LABEL_PROCESS_BROKER

See Also:

Constant Field Values

LABEL_PROCESS_CONTROLLER

public static final String LABEL_PROCESS_CONTROLLER

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

KafkaServerProvider

public KafkaServerProvider()

Method Detail

configure

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

Specified by:

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

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.

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.

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

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

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

configInclude

public Predicate<String> configInclude()

Description copied from interface: Provider

Include list for config

Specified by:

configInclude in interface Provider

Returns:

Regex for filtering config keys.