Procházet zdrojové kódy

chore: add changelog for create trace

Zhongwen Deng před 2 roky
rodič
revize
45254c5936

+ 8 - 2
apps/emqx/src/emqx_trace/emqx_trace_handler.erl

@@ -44,7 +44,8 @@
 -type tracer() :: #{
     name := binary(),
     type := clientid | topic | ip_address,
-    filter := emqx_types:clientid() | emqx_types:topic() | emqx_trace:ip_address()
+    filter := emqx_types:clientid() | emqx_types:topic() | emqx_trace:ip_address(),
+    payload_encode := text | hidden | hex
 }.
 
 -define(CONFIG(_LogFile_), #{
@@ -70,7 +71,12 @@
     LogFilePath :: string()
 ) -> ok | {error, term()}.
 install(Name, Type, Filter, Level, LogFile) ->
-    Who = #{type => Type, filter => ensure_bin(Filter), name => ensure_bin(Name)},
+    Who = #{
+        type => Type,
+        filter => ensure_bin(Filter),
+        name => ensure_bin(Name),
+        payload_encode => payload_encode()
+    },
     install(Who, Level, LogFile).
 
 -spec install(

+ 2 - 1
apps/emqx_management/src/emqx_mgmt_api_trace.erl

@@ -273,7 +273,8 @@ fields(trace) ->
                     "Determine the format of the payload format in the trace file.<br/>\n"
                     "`text`: Text-based protocol or plain text protocol.\n"
                     " It is recommended when payload is JSON encoded.<br/>\n"
-                    "`hex`: Binary hexadecimal encode. It is recommended when payload is a custom binary protocol.<br/>\n"
+                    "`hex`: Binary hexadecimal encode."
+                    "It is recommended when payload is a custom binary protocol.<br/>\n"
                     "`hidden`: payload is obfuscated as `******`"
                     "",
                 default => text,

+ 2 - 0
changes/ce/feat-10373.en.md

@@ -0,0 +1,2 @@
+Deprecate the trace.payload_encode configuration.
+Add payload_encode=[text,hidden,hex] option when creating a trace via HTTP API.