org.apache.kafka.streams

Interface StreamsMetrics

public interface StreamsMetrics

The Kafka Streams metrics interface for adding metric sensors and collecting metric values.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.kafka.common.metrics.Sensor	addLatencySensor(String scopeName, String entityName, String operationName, String... tags) Add the latency sensor.
void	recordLatency(org.apache.kafka.common.metrics.Sensor sensor, long startNs, long endNs) Record the given latency value of the sensor.

Method Detail

addLatencySensor

org.apache.kafka.common.metrics.Sensor addLatencySensor(String scopeName,
                                                      String entityName,
                                                      String operationName,
                                                      String... tags)

Add the latency sensor.

Parameters:

scopeName - Name of the scope, could be the type of the state store, etc.

entityName - Name of the entity, could be the name of the state store instance, etc.

operationName - Name of the operation, could be get / put / delete / etc.

tags - Additional tags of the sensor.

Returns:

The added sensor.

recordLatency

void recordLatency(org.apache.kafka.common.metrics.Sensor sensor,
                 long startNs,
                 long endNs)

Record the given latency value of the sensor.