Procházet zdrojové kódy

docs(kafka_consumer): make specific labels for key/value encoding modes

https://emqx.atlassian.net/browse/EMQX-9312
Thales Macedo Garitezi před 2 roky
rodič
revize
5bdc71af6f

+ 23 - 6
lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf

@@ -629,20 +629,37 @@ emqx_ee_bridge_kafka {
             zh: "主题映射关系"
             zh: "主题映射关系"
         }
         }
     }
     }
-    consumer_encoding_mode {
+    consumer_key_encoding_mode {
         desc {
         desc {
-            en: "Defines how the key or value from the Kafka message is"
+            en: "Defines how the key from the Kafka message is"
                 " dealt with before being forwarded via MQTT.\n"
                 " dealt with before being forwarded via MQTT.\n"
-                "<code>none</code> Uses the key or value from the Kafka message unchanged."
-                "  Note: in this case, then the key or value must be a valid UTF-8 string.\n"
-                "<code>base64</code> Uses base-64 encoding on the received key or value."
+                "<code>none</code> Uses the key from the Kafka message unchanged."
+                "  Note: in this case, then the key must be a valid UTF-8 string.\n"
+                "<code>base64</code> Uses base-64 encoding on the received key."
             zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。"
             zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。"
                 "<code>none</code> 使用Kafka消息中的键或值,不改变。"
                 "<code>none</code> 使用Kafka消息中的键或值,不改变。"
                 "  注意:在这种情况下,那么键或值必须是一个有效的UTF-8字符串。\n"
                 "  注意:在这种情况下,那么键或值必须是一个有效的UTF-8字符串。\n"
                 "<code>base64</code> 对收到的密钥或值使用base-64编码。"
                 "<code>base64</code> 对收到的密钥或值使用base-64编码。"
         }
         }
         label {
         label {
-            en: "Encoding Mode"
+            en: "Key Encoding Mode"
+            zh: "编码模式"
+        }
+    }
+    consumer_value_encoding_mode {
+        desc {
+            en: "Defines how the value from the Kafka message is"
+                " dealt with before being forwarded via MQTT.\n"
+                "<code>none</code> Uses the value from the Kafka message unchanged."
+                "  Note: in this case, then the value must be a valid UTF-8 string.\n"
+                "<code>base64</code> Uses base-64 encoding on the received value."
+            zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。"
+                "<code>none</code> 使用Kafka消息中的键或值,不改变。"
+                "  注意:在这种情况下,那么键或值必须是一个有效的UTF-8字符串。\n"
+                "<code>base64</code> 对收到的密钥或值使用base-64编码。"
+        }
+        label {
+            en: "Value Encoding Mode"
             zh: "编码模式"
             zh: "编码模式"
         }
         }
     }
     }

+ 2 - 2
lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl

@@ -338,11 +338,11 @@ fields(consumer_opts) ->
             )},
             )},
         {key_encoding_mode,
         {key_encoding_mode,
             mk(enum([none, base64]), #{
             mk(enum([none, base64]), #{
-                default => none, desc => ?DESC(consumer_encoding_mode)
+                default => none, desc => ?DESC(consumer_key_encoding_mode)
             })},
             })},
         {value_encoding_mode,
         {value_encoding_mode,
             mk(enum([none, base64]), #{
             mk(enum([none, base64]), #{
-                default => none, desc => ?DESC(consumer_encoding_mode)
+                default => none, desc => ?DESC(consumer_value_encoding_mode)
             })}
             })}
     ];
     ];
 fields(consumer_topic_mapping) ->
 fields(consumer_topic_mapping) ->