Preparing release v0.2.2 (#100)

* Prepared `CHANGELOG` for release `v0.2.2` * Updated `README` given what has been completed * Bumped to version `v0.2.2`
kafkesc · Nov 19, 2023 · 0931f89 · 0931f89
1 parent e5f6e9b
commit 0931f89
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,20 @@
-# vNEXT (????-??-??)
+# v0.2.2 (2023-11-19)
+
+## Features
+
+* Exposed `consumer_groups` module metrics ([I#53](https://github.com/kafkesc/kommitted/issues/53), [I#55](https://github.com/kafkesc/kommitted/issues/55))
+* Exposed `partition_offsets` module metrics ([I#57](https://github.com/kafkesc/kommitted/issues/57))
+* Exposed `cluster_status` module metrics ([I#54](https://github.com/kafkesc/kommitted/issues/54), [I#56](https://github.com/kafkesc/kommitted/issues/56))
 
 ## Enhancements
 
 * Reworked workflows that publish Docker image: triggering 1 dedicated workflow per target ([I#80](https://github.com/kafkesc/kommitted/issues/80))
 
+## Notes
+
+* Multiple rounds of dependencies upgrade
+* Updated [`METRICS.md`](./METRICS.md) with documentation for each of the added metrics
+
 # v0.2.1 (2023-10-04)
 
 ## Features

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "kommitted"
-version = "0.2.1"
+version = "0.2.2"
 edition = "2021"
 authors = [
     "Ivan De Marino <detronizator@gmail.com>",

diff --git a/README.md b/README.md
@@ -27,8 +27,8 @@ Please see [DESIGN.md](./DESIGN.md) for details about the overall architecture,
 * [x] Track Offset Lag for all consumers
 * [x] Track Time Lag for all consumers
 * [x] Offset and Lag metrics are tracked with all contextual information to identify exact topic partition assignments
-* [ ] Exposes additional metrics to track status of Kafka cluster (topics, members, brokers, partitions)
-* [ ] Exposes Kafka-polling metrics, to assess its own performance
+* [x] Exposes additional metrics to track status of Kafka cluster (topics, members, brokers, partitions)
+* [x] Exposes Kafka-polling metrics, to assess its own performance
 * [x] Metrics exposed in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats), at `/metrics` endpoint
 * [ ] REST API to build further automation on top of it (e.g. auto-scaling logics that depend on Consumer Group lag)
 
@@ -61,7 +61,7 @@ Kommitted supports _compact_ (`-h`) and _extended_ (`--help`) usage instructions
 Use the former for a quick look up; use the latter to better understand what
 each argument can do.
 
-<details open>
+<details>
   <summary>Compact: `kommitted -h`</summary>
 
   ```shell