Package org.apache.kafka.common.metrics

Class KafkaMetricsContext

java.lang.Object

org.apache.kafka.common.metrics.KafkaMetricsContext

All Implemented Interfaces:

MetricsContext

public class KafkaMetricsContext
extends Object
implements MetricsContext

A implementation of MetricsContext, it encapsulates required metrics context properties for Kafka services and clients

Field Summary

Fields inherited from interface org.apache.kafka.common.metrics.MetricsContext

NAMESPACE

Constructor Summary

Constructors

Constructor	Description
KafkaMetricsContext(String namespace)	Create a MetricsContext with namespace, no service or client properties
KafkaMetricsContext(String namespace, Map<String,?> contextLabels)	Create a MetricsContext with namespace, service or client properties

Method Summary

Modifier and Type	Method	Description
Map<String,String>	contextLabels()	Returns the labels for this metrics context.

Methods inherited from class java.lang.Object

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

Constructor Details

KafkaMetricsContext

public KafkaMetricsContext(String namespace)

Create a MetricsContext with namespace, no service or client properties

Parameters:

namespace - value for _namespace key

KafkaMetricsContext

public KafkaMetricsContext(String namespace,
Map<String,?> contextLabels)

Create a MetricsContext with namespace, service or client properties

Parameters:

namespace - value for _namespace key

contextLabels - contextLabels additional entries to add to the context. values will be converted to string using Object.toString()

Method Details

contextLabels

public Map<String,String> contextLabels()

Description copied from interface: MetricsContext

Returns the labels for this metrics context.

Specified by:

contextLabels in interface MetricsContext

Returns:

the map of label keys and values; never null but possibly empty