Package org.apache.kafka.streams

Interface ClientInstanceIds

public interface ClientInstanceIds
Encapsulates the client instance id used for metrics collection by producers, consumers, and the admin client used by Kafka Streams.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.kafka.common.Uuid
    adminInstanceId()
    Returns the client instance id of the admin client.
    Map<String,org.apache.kafka.common.Uuid>
    consumerInstanceIds()
    Returns the client instance id of the consumers.
    Map<String,org.apache.kafka.common.Uuid>
    producerInstanceIds()
    Returns the client instance id of the producers.

  • Method Details

    • adminInstanceId

      org.apache.kafka.common.Uuid adminInstanceId()
      Returns the client instance id of the admin client.
      Returns:
      the client instance id of the admin client
      Throws:
      IllegalStateException - If telemetry is disabled on the admin client.

    • consumerInstanceIds

      Map<String,org.apache.kafka.common.Uuid> consumerInstanceIds()
      Returns the client instance id of the consumers.
      Returns:
      a map from thread key to client instance id

    • producerInstanceIds

      Map<String,org.apache.kafka.common.Uuid> producerInstanceIds()
      Returns the client instance id of the producers.
      Returns:
      a map from thread key to client instance id