All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
3.2.0 (2024-05-07)
The detailed changelog can be found here.
- Missing initialization for kafka_consumer_fetch_duration_seconds (issue #91)
- Missing initialization for kafka_consumer_batch_duration_seconds
The detailed changelog can be found here.
- support for new metrics kafka_consumer_fetch_duration_seconds_count, kafka_consumer_fetch_duration_seconds_sum and kafka_consumer_fetch_duration_seconds_bucket. These are replacements for the corresponding kafka_consumer_fetch_latency.* metrics. See also the deprecation notices below.
- support for new metrics kafka_consumer_batch_duration_seconds_count, kafka_consumer_batch_duration_seconds_sum and kafka_consumer_batch_duration_seconds_bucket. These are replacements for the corresponding kafka_consumer_batch_latency.* metrics. See also the deprecation notices below.
- support for new metrics kafka_admin_request_duration_seconds_count, kafka_admin_request_duration_seconds_sum and kafka_admin_request_duration_seconds_bucket. kafka_admin_request_duration_seconds_count and kafka_admin_request_total contain the same value.
- support for new metrics kafka_producer_request_duration_seconds_count, kafka_producer_request_duration_seconds_sum and kafka_producer_request_duration_seconds_bucket. kafka_producer_request_duration_seconds_count and kafka_producer_request_total contain the same value.
- support for new metrics kafka_consumer_request_duration_seconds_count, kafka_consumer_request_duration_seconds_sum and kafka_consumer_request_duration_seconds_bucket. kafka_consumer_request_duration_seconds_count and kafka_consumer_request_total contain the same value.
- kafka_admin_request_total will be potentially removed in a future version in favor of kafka_admin_request_duration_seconds_count. It is recommended to already switch now to the new metric.
- kafka_producer_request_total will be potentially removed in a future version in favor of kafka_producer_request_duration_seconds_count. It is recommended to already switch now to the new metric.
- kafka_consumer_request_total will be potentially removed in a future version in favor of kafka_consumer_request_duration_seconds_count. It is recommended to already switch now to the new metric.
- kafka_consumer_fetch_latency_count, kafka_consumer_fetch_latency_sum and kafka_consumer_fetch_latency_buckets will be removed in the next major release and are replaced with kafka_consumer_fetch_duration_seconds.* counterparts. This is to better align the metric names with the Prometheus naming conventions and other metrics used in the Prometheus ecosystem. It is recommended to already switch now to the new metrics.
- kafka_consumer_batch_latency_count, kafka_consumer_batch_latency_sum and kafka_consumer_batch_latency_buckets will be removed in the next major release and are replaced with the kafka_consumer_batch_duration_seconds.* counterparts. This is to better align the metric names with the Prometheus naming conventions and other metrics used in the Prometheus ecosystem. It is recommended to already switch now to the new metrics.
The detailed changelog can be found here.
- Fixed missing label group_id for kafka_consumer_connection_crashed_total metric.
The detailed changelog can be found here.
- upgraded prom-client from 14.2.0 to 15.0.0
- added compatibility matrix to documentation
- introduced Github actions for complete build process
- added Github actions for build and snyk
- added renovate to build process
- client_id is no longer a mandatory parameter for monitorKafkaJSProducer, monitorKafkaJSConsumer and monitorKafkaJSAdmin respectively. This is to harmonize the interface with KafkaJS, remove special handling for client_id and prepare for a future release of KafkaJS where the client_id is provided by KafkaJS instrumentation events for all metrics and not only for some. Instead it is strongly recommended to add the client_id as a default label until the client_id is provided by KafkaJS instrumentation events.
- Fixed wrong path to main entry.
- support for new metrics for the admin client.
- support for new metrics kafka_consumer_batch_size_total, kafka_consumer_request_size_total and kafka_producer_request_size_total.
- added Grafana dashboard sample
- wrong label definition for client_id in consumer request queue size metric
- initial project setup
- support for major consumer and producer metrics
- support for configuration for exporters