kafka-streams-StreamsMetrics.adoc

StreamsMetrics

StreamsMetrics is a contract of streams metrics that FIXME.

package org.apache.kafka.streams;

interface StreamsMetrics {
  Map<MetricName, ? extends Metric> metrics();
  Sensor addLatencyAndThroughputSensor(
    final String scopeName,
    final String entityName,
    final String operationName,
    final Sensor.RecordingLevel recordingLevel,
    final String... tags);
  void recordLatency(
    final Sensor sensor,
    final long startNs,
    final long endNs);
  Sensor addThroughputSensor(
    final String scopeName,
    final String entityName,
    final String operationName,
    final Sensor.RecordingLevel recordingLevel,
    final String... tags);
  void recordThroughput(
    final Sensor sensor,
    final long value);
  Sensor addSensor(
    final String name,
    final Sensor.RecordingLevel recordingLevel);
  Sensor addSensor(
    final String name,
    final Sensor.RecordingLevel recordingLevel,
    final Sensor... parents);
  void removeSensor(final Sensor sensor);
}

Note	StreamsMetrics is an Evolving contract which means that compatibility may be broken at a minor release.

Table 1. StreamsMetrics Contract

Method	Description
metrics	Used when…​FIXME
recordLatency	Recording a latency with a Kafka Sensor Used when…​FIXME

Note	StreamsMetricsImpl is the one and only known direct implementation of StreamsMetrics Contract in Kafka Streams {{ book.kafka_version }}.