feat: Add better docs for the new config foramt

olksdr · olksdr · commit f9679331735d · 2022-09-12T11:09:14.000+02:00
diff --git a/relay-config/src/config.rs b/relay-config/src/config.rs
@@ -938,8 +938,27 @@ pub enum KafkaConfig<'a> {
     Single(KafkaParams<'a>),
 
     /// The list of the Kafka configs with related shard configs.
+    /// The configuration for this should look like:
+    ///     ```
+    ///     metrics:
+    ///        shards: 65000
+    ///        mapping:
+    ///          0:
+    ///              name: "ingest-metrics-1"
+    ///              config: "metric_1"
+    ///          25000:
+    ///              name: "ingest-metrics-2"
+    ///              config: "metrics_2"
+    ///          45000:
+    ///              name: "ingest-metrics-3"
+    ///              config: "metrics_3"
+    ///     ```
+    ///
+    /// where the `shards` defines how many logical shards must be created, and `mapping`
+    /// describes the per-shard configuration. Index in the `mapping` is the initial inclusive
+    /// index of the shard. And it always must start with 0.
     Sharded {
-        /// the maximum number of logical shards for this set of configs.
+        /// The maximum number of logical shards for this set of configs.
         shards: u64,
         /// The list of the sharded Kafka configs.
         configs: BTreeMap<u64, KafkaParams<'a>>,
