Package org.apache.kafka.common.metrics

Interface MetricsContext

All Known Implementing Classes:
KafkaMetricsContext
@Evolving public interface MetricsContext
MetricsContext encapsulates additional contextLabels about metrics exposed via a MetricsReporter

The contextLabels() map provides following information:

in all components
a _namespace field indicating the component exposing metrics e.g. kafka.server, kafka.consumer. The JmxReporter uses this as prefix for MBean names
for clients and streams libraries
any freeform fields passed in via client properties in the form of metrics.context.<key>=<value>
for kafka brokers
kafka.broker.id, kafka.cluster.id
for connect workers
connect.kafka.cluster.id, connect.group.id

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAMESPACE
     

  • Method Summary

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

  • Field Details

  • Method Details

    • contextLabels

      Map<String,String> contextLabels()
      Returns the labels for this metrics context.
      Returns:
      the map of label keys and values; never null but possibly empty