Package org.apache.kafka.common.metrics

Class JmxReporter

java.lang.Object

org.apache.kafka.common.metrics.JmxReporter

All Implemented Interfaces:

AutoCloseable, Configurable, MetricsReporter, Reconfigurable

public class JmxReporter
extends Object
implements MetricsReporter

Register metrics in JMX as dynamic mbeans based on the metric names

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EXCLUDE
static final String	DEFAULT_INCLUDE
static final String	EXCLUDE_CONFIG
static final String	EXCLUDE_CONFIG_ALIAS
static final String	INCLUDE_CONFIG
static final String	INCLUDE_CONFIG_ALIAS
static final String	METRICS_CONFIG_PREFIX
static final Set<String>	RECONFIGURABLE_CONFIGS

Constructor Summary

Constructors

Constructor	Description
JmxReporter()
JmxReporter(String prefix)	Deprecated. Since 2.6.0.

Method Summary

Modifier and Type	Method	Description
void	close()	Called when the metrics repository is closed.
static Predicate<String>	compilePredicate(Map<String,?> originalConfig)
void	configure(Map<String,?> configs)	Configure this class with the given key-value pairs
boolean	containsMbean(String mbeanName)
void	contextChange(MetricsContext metricsContext)	Sets the context labels for the service or library exposing metrics.
void	init(List<KafkaMetric> metrics)	This is called when the reporter is first registered to initially register all existing metrics
void	metricChange(KafkaMetric metric)	This is called whenever a metric is updated or added
void	metricRemoval(KafkaMetric metric)	This is called whenever a metric is removed
Set<String>	reconfigurableConfigs()	Returns the names of configs that may be reconfigured.
void	reconfigure(Map<String,?> configs)	Reconfigures this instance with the given key-value pairs.
void	validateReconfiguration(Map<String,?> configs)	Validates the provided configuration.

Methods inherited from class java.lang.Object

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

Field Details

METRICS_CONFIG_PREFIX

public static final String METRICS_CONFIG_PREFIX

See Also:

• Constant Field Values

EXCLUDE_CONFIG

public static final String EXCLUDE_CONFIG

See Also:

• Constant Field Values

EXCLUDE_CONFIG_ALIAS

public static final String EXCLUDE_CONFIG_ALIAS

See Also:

• Constant Field Values

INCLUDE_CONFIG

public static final String INCLUDE_CONFIG

See Also:

• Constant Field Values

INCLUDE_CONFIG_ALIAS

public static final String INCLUDE_CONFIG_ALIAS

See Also:

• Constant Field Values

RECONFIGURABLE_CONFIGS

public static final Set<String> RECONFIGURABLE_CONFIGS

DEFAULT_INCLUDE

public static final String DEFAULT_INCLUDE

See Also:

• Constant Field Values

DEFAULT_EXCLUDE

public static final String DEFAULT_EXCLUDE

See Also:

• Constant Field Values

Constructor Details

JmxReporter

public JmxReporter()

JmxReporter

@Deprecated
public JmxReporter(String prefix)

Deprecated.

Since 2.6.0. Use JmxReporter() Initialize JmxReporter with contextChange(MetricsContext) Populate prefix by adding _namespace/prefix key value pair to MetricsContext

Create a JMX reporter that prefixes all metrics with the given string.

Method Details

configure

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

Description copied from interface: Configurable

Configure this class with the given key-value pairs

Specified by:

configure in interface Configurable

reconfigurableConfigs

public Set<String> reconfigurableConfigs()

Description copied from interface: Reconfigurable

Returns the names of configs that may be reconfigured.

Specified by:

reconfigurableConfigs in interface MetricsReporter

Specified by:

reconfigurableConfigs in interface Reconfigurable

validateReconfiguration

public void validateReconfiguration(Map<String,?> configs)
                             throws ConfigException

Description copied from interface: Reconfigurable

Validates the provided configuration. The provided map contains all configs including any reconfigurable configs that may be different from the initial configuration. Reconfiguration will be not performed if this method throws any exception.

Specified by:

validateReconfiguration in interface MetricsReporter

Specified by:

validateReconfiguration in interface Reconfigurable

Throws:

ConfigException - if the provided configs are not valid. The exception message from ConfigException will be returned to the client in the AlterConfigs response.

reconfigure

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

Description copied from interface: Reconfigurable

Reconfigures this instance with the given key-value pairs. The provided map contains all configs including any reconfigurable configs that may have changed since the object was initially configured using Configurable.configure(Map). This method will only be invoked if the configs have passed validation using Reconfigurable.validateReconfiguration(Map).

Specified by:

reconfigure in interface MetricsReporter

Specified by:

reconfigure in interface Reconfigurable

init

public void init(List<KafkaMetric> metrics)

Description copied from interface: MetricsReporter

This is called when the reporter is first registered to initially register all existing metrics

Specified by:

init in interface MetricsReporter

Parameters:

metrics - All currently existing metrics

containsMbean

public boolean containsMbean(String mbeanName)

metricChange

public void metricChange(KafkaMetric metric)

Description copied from interface: MetricsReporter

This is called whenever a metric is updated or added

Specified by:

metricChange in interface MetricsReporter

metricRemoval

public void metricRemoval(KafkaMetric metric)

Description copied from interface: MetricsReporter

This is called whenever a metric is removed

Specified by:

metricRemoval in interface MetricsReporter

close

public void close()

Description copied from interface: MetricsReporter

Called when the metrics repository is closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MetricsReporter

compilePredicate

public static Predicate<String> compilePredicate(Map<String,?> originalConfig)

contextChange

public void contextChange(MetricsContext metricsContext)

Description copied from interface: MetricsReporter

Sets the context 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 MetricsReporter

Parameters:

metricsContext - the metric context