diff --git a/docs/ops.html b/docs/ops.html index 47b7498d25c..c299d7c8dbd 100644 --- a/docs/ops.html +++ b/docs/ops.html @@ -2753,7 +2753,7 @@ These metrics are reported on both Controllers and Brokers in a KRaft Cluster
metrics.recording.level="info"
Client Metrics
-All of the following metrics have a recording level of info: +All the following metrics have a recording level of info: @@ -2800,7 +2800,7 @@ All of the following metrics have a recording level of info:
Thread Metrics
-All of the following metrics have a recording level of info: +All the following metrics have a recording level of info: @@ -2850,7 +2850,7 @@ All of the following metrics have a recording level of info: - + @@ -2860,7 +2860,7 @@ All of the following metrics have a recording level of info: - + @@ -2870,7 +2870,7 @@ All of the following metrics have a recording level of info: - + @@ -2880,7 +2880,7 @@ All of the following metrics have a recording level of info: - + @@ -2890,7 +2890,7 @@ All of the following metrics have a recording level of info: - + @@ -2900,7 +2900,7 @@ All of the following metrics have a recording level of info: - + @@ -2910,19 +2910,19 @@ All of the following metrics have a recording level of info: - + - +
commit-rateThe average number of commits per second.The average number of commits per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
poll-rateThe average number of consumer poll calls per second.The average number of consumer poll calls per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
process-rateThe average number of processed records per second.The average number of processed records per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
punctuate-rateThe average number of punctuate calls per second.The average number of punctuate calls per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
task-created-rateThe average number of tasks created per second.The average number of tasks created per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
task-closed-rateThe average number of tasks closed per second.The average number of tasks closed per sec. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
blocked-time-ns-totalThe total time the thread spent blocked on kafka.The total time in ns the thread spent blocked on Kafka brokers. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
thread-start-timeThe time that the thread was started.The system timestamp in ms that the thread was started. kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)
Task Metrics
-All of the following metrics have a recording level of debug, except for the dropped-records-* and +All the following metrics have a recording level of debug, except for the dropped-records-* and active-process-ratio metrics which have a recording level of info: @@ -2943,7 +2943,7 @@ active-process-ratio metrics which have a recording level of info: - + @@ -2953,17 +2953,17 @@ active-process-ratio metrics which have a recording level of info: - + - + - + @@ -2973,7 +2973,7 @@ active-process-ratio metrics which have a recording level of info: - + @@ -3005,7 +3005,7 @@ active-process-ratio metrics which have a recording level of info: emit-final-* metrics are only available for windowed aggregations nodes, and the record-e2e-latency-* metrics are only available for source processor nodes and terminal nodes (nodes without successor nodes). - All of the metrics have a recording level of debug, except for the record-e2e-latency-* metrics which have + All the metrics have a recording level of debug, except for the record-e2e-latency-* metrics which have a recording level of info:
process-rateThe average number of processed records per second across all source processor nodes of this task.The average number of processed records per sec across all source processor nodes of this task. kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)
record-lateness-avgThe average observed lateness of records (stream time - record timestamp).The average observed lateness in ms of records (stream time - record timestamp). kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)
record-lateness-maxThe max observed lateness of records (stream time - record timestamp).The max observed lateness in ms of records (stream time - record timestamp). kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)
enforced-processing-rateThe average number of enforced processings per second.The average number of enforced processings per sec. kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)
dropped-records-rateThe average number of records dropped within this task.The average number of records dropped per sec within this task. kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)
@@ -3026,17 +3026,17 @@ active-process-ratio metrics which have a recording level of info: - + - + - + @@ -3046,17 +3046,17 @@ active-process-ratio metrics which have a recording level of info: - + - + - + @@ -3066,17 +3066,17 @@ active-process-ratio metrics which have a recording level of info: - + - + - + @@ -3219,42 +3219,42 @@ customized state stores; for built-in state stores, currently we have: - + - + - + - + - + - + - + - + @@ -3269,7 +3269,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3289,17 +3289,17 @@ customized state stores; for built-in state stores, currently we have: - + - + - + @@ -3309,17 +3309,17 @@ customized state stores; for built-in state stores, currently we have: - + - + - + @@ -3339,7 +3339,7 @@ customized state stores; for built-in state stores, currently we have: RocksDB Statistics-based Metrics: - All of the following statistics-based metrics have a recording level of debug because collecting + All the following statistics-based metrics have a recording level of debug because collecting statistics in RocksDB may have an impact on performance. Statistics-based metrics are collected every minute from the RocksDB state stores. @@ -3355,7 +3355,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3375,7 +3375,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3390,7 +3390,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3400,7 +3400,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3420,27 +3420,27 @@ customized state stores; for built-in state stores, currently we have: - + - + - + - + - + @@ -3450,7 +3450,7 @@ customized state stores; for built-in state stores, currently we have: - + @@ -3467,7 +3467,7 @@ customized state stores; for built-in state stores, currently we have:
process-rateThe average number of records processed by a source processor node per second.The average number of records processed by a source processor node per sec. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
process-totalThe total number of records processed by a source processor node per second.The total number of records processed by a source processor node per sec. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
suppression-emit-rateThe rate at which records that have been emitted downstream from suppression operation nodes.The rate of records emitted per sec that have been emitted downstream from suppression operation nodes. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
emit-final-latency-maxThe max latency to emit final records when a record could be emitted.The max latency in ms to emit final records when a record could be emitted. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
emit-final-latency-avgThe avg latency to emit final records when a record could be emitted.The avg latency in ms to emit final records when a record could be emitted. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
emit-final-records-rateThe rate of records emitted when records could be emitted.The rate of records emitted per sec when records could be emitted. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
record-e2e-latency-avgThe average end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The average end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
record-e2e-latency-maxThe maximum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The maximum end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
record-e2e-latency-minThe minimum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The minimum end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-processor-node-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),processor-node-id=([-.\w]+)
put-rateThe average put rate for this store.The average put rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
put-if-absent-rateThe average put-if-absent rate for this store.The average put-if-absent rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
get-rateThe average get rate for this store.The average get rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
delete-rateThe average delete rate for this store.The average delete rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
put-all-rateThe average put-all rate for this store.The average put-all rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
all-rateThe average all operation rate for this store.The average all operation rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
range-rateThe average range rate for this store.The average range rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
prefix-scan-rateThe average prefix-scan rate for this store.The average prefix-scan rate per sec for this store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
suppression-buffer-size-avgThe average total size, in bytes, of the buffered data over the sampling window.The average total size in bytes of the buffered data over the sampling window. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),in-memory-suppression-id=([-.\w]+)
record-e2e-latency-avgThe average end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The average end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
record-e2e-latency-maxThe maximum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The maximum end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
record-e2e-latency-minThe minimum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.The minimum end-to-end latency in ms of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
iterator-duration-avgThe average time spent between creating an iterator and closing it, in nanoseconds.The average time in ns spent between creating an iterator and closing it. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
iterator-duration-maxThe maximum time spent between creating an iterator and closing it, in nanoseconds.The maximum time in ns spent between creating an iterator and closing it. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
oldest-iterator-open-since-msThe UNIX timestamp the oldest still open iterator was created, in milliseconds.The system timestamp in ms the oldest still open iterator was created. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
bytes-written-rateThe average number of bytes written per second to the RocksDB state store.The average number of bytes written per sec to the RocksDB state store. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
memtable-bytes-flushed-rateThe average number of bytes flushed per second from the memtable to disk.The average number of bytes flushed per sec from the memtable to disk. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
memtable-flush-time-avgThe average duration of memtable flushes to disc in ms.The average duration in ms of memtable flushes to disc. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
memtable-flush-time-maxThe maximum duration of memtable flushes to disc in ms.The maximum duration in ms of memtable flushes to disc. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
write-stall-duration-avgThe average duration of write stalls in ms.The average duration in ms of write stalls. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
write-stall-duration-totalThe total duration of write stalls in ms.The total duration in ms of write stalls. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
bytes-read-compaction-rateThe average number of bytes read per second during compaction.The average number of bytes read per sec during compaction. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
bytes-written-compaction-rateThe average number of bytes written per second during compaction.The average number of bytes written per sec during compaction. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
compaction-time-avgThe average duration of disc compactions in ms.The average duration in ms of disc compactions. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
compaction-time-maxThe maximum duration of disc compactions in ms.The maximum duration in ms of disc compactions. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)
RocksDB Properties-based Metrics: - All of the following properties-based metrics have a recording level of info and are recorded when the + All the following properties-based metrics have a recording level of info and are recorded when the metrics are accessed. If a state store consists of multiple RocksDB instances, as is the case for WindowStores and SessionStores, each metric reports the sum over all the RocksDB instances of the state store, except for the block cache metrics @@ -3489,17 +3489,17 @@ customized state stores; for built-in state stores, currently we have: cur-size-active-mem-table - The approximate size of the active memtable in bytes. + The approximate size in bytes of the active memtable. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) cur-size-all-mem-tables - The approximate size of active and unflushed immutable memtables in bytes. + The approximate size in bytes of active and unflushed immutable memtables. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) size-all-mem-tables - The approximate size of active, unflushed immutable, and pinned immutable memtables in bytes. + The approximate size in bytes of active, unflushed immutable, and pinned immutable memtables. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) @@ -3565,17 +3565,17 @@ customized state stores; for built-in state stores, currently we have: block-cache-capacity - The capacity of the block cache in bytes. + The capacity in bytes of the block cache. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) block-cache-usage - The memory size of the entries residing in block cache in bytes. + The memory size in bytes of the entries residing in block cache. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) block-cache-pinned-usage - The memory size for the entries being pinned in the block cache in bytes. + The memory size in bytes for the entries being pinned in the block cache. kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+) @@ -3597,7 +3597,7 @@ customized state stores; for built-in state stores, currently we have:
Record Cache Metrics
- All of the following metrics have a recording level of debug: + All the following metrics have a recording level of debug: diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/ProcessorNodeMetrics.java b/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/ProcessorNodeMetrics.java index b61a4fb3e27..ca26b702839 100644 --- a/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/ProcessorNodeMetrics.java +++ b/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/ProcessorNodeMetrics.java @@ -22,6 +22,7 @@ import org.apache.kafka.common.metrics.Sensor.RecordingLevel; import java.util.Map; import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.AVG_LATENCY_DESCRIPTION; +import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.LATENCY_DESCRIPTION_SUFFIX; import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.LATENCY_SUFFIX; import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.MAX_LATENCY_DESCRIPTION; import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.PROCESSOR_NODE_LEVEL_GROUP; @@ -68,8 +69,8 @@ public class ProcessorNodeMetrics { private static final String EMIT_FINAL_LATENCY = EMITTED_RECORDS + LATENCY_SUFFIX; private static final String EMIT_FINAL_DESCRIPTION = "calls to emit final"; - private static final String EMIT_FINAL_AVG_LATENCY_DESCRIPTION = AVG_LATENCY_DESCRIPTION + EMIT_FINAL_DESCRIPTION; - private static final String EMIT_FINAL_MAX_LATENCY_DESCRIPTION = MAX_LATENCY_DESCRIPTION + EMIT_FINAL_DESCRIPTION; + private static final String EMIT_FINAL_AVG_LATENCY_DESCRIPTION = AVG_LATENCY_DESCRIPTION + EMIT_FINAL_DESCRIPTION + LATENCY_DESCRIPTION_SUFFIX; + private static final String EMIT_FINAL_MAX_LATENCY_DESCRIPTION = MAX_LATENCY_DESCRIPTION + EMIT_FINAL_DESCRIPTION + LATENCY_DESCRIPTION_SUFFIX; public static Sensor suppressionEmitSensor(final String threadId, final String taskId, diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/StreamsMetricsImpl.java b/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/StreamsMetricsImpl.java index af693d14bc3..670c2ef639a 100644 --- a/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/StreamsMetricsImpl.java +++ b/streams/src/main/java/org/apache/kafka/streams/processor/internals/metrics/StreamsMetricsImpl.java @@ -151,6 +151,7 @@ public class StreamsMetricsImpl implements StreamsMetrics { public static final String RATIO_DESCRIPTION = "The fraction of time the thread spent on "; public static final String AVG_LATENCY_DESCRIPTION = "The average latency of "; public static final String MAX_LATENCY_DESCRIPTION = "The maximum latency of "; + public static final String LATENCY_DESCRIPTION_SUFFIX = " in milliseconds"; public static final String RATE_DESCRIPTION_PREFIX = "The average number of "; public static final String RATE_DESCRIPTION_SUFFIX = " per second";