From 5bdc71af6fe34eb82a5c08a75f492da86cb125f5 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 24 Mar 2023 09:08:27 -0300 Subject: [PATCH] docs(kafka_consumer): make specific labels for key/value encoding modes https://emqx.atlassian.net/browse/EMQX-9312 --- .../i18n/emqx_ee_bridge_kafka.conf | 29 +++++++++++++++---- .../src/emqx_ee_bridge_kafka.erl | 4 +-- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf index 00f1f1031..abf1c34b7 100644 --- a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf +++ b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf @@ -629,20 +629,37 @@ emqx_ee_bridge_kafka { zh: "主题映射关系" } } - consumer_encoding_mode { + consumer_key_encoding_mode { 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" - "none 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" - "base64 Uses base-64 encoding on the received key or value." + "none Uses the key from the Kafka message unchanged." + " Note: in this case, then the key must be a valid UTF-8 string.\n" + "base64 Uses base-64 encoding on the received key." zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" "none 使用Kafka消息中的键或值,不改变。" " 注意:在这种情况下,那么键或值必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" } 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" + "none Uses the value from the Kafka message unchanged." + " Note: in this case, then the value must be a valid UTF-8 string.\n" + "base64 Uses base-64 encoding on the received value." + zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" + "none 使用Kafka消息中的键或值,不改变。" + " 注意:在这种情况下,那么键或值必须是一个有效的UTF-8字符串。\n" + "base64 对收到的密钥或值使用base-64编码。" + } + label { + en: "Value Encoding Mode" zh: "编码模式" } } diff --git a/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl b/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl index 30a58e4e0..3db8dd5f1 100644 --- a/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl +++ b/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl @@ -338,11 +338,11 @@ fields(consumer_opts) -> )}, {key_encoding_mode, mk(enum([none, base64]), #{ - default => none, desc => ?DESC(consumer_encoding_mode) + default => none, desc => ?DESC(consumer_key_encoding_mode) })}, {value_encoding_mode, mk(enum([none, base64]), #{ - default => none, desc => ?DESC(consumer_encoding_mode) + default => none, desc => ?DESC(consumer_value_encoding_mode) })} ]; fields(consumer_topic_mapping) ->