yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(emqx_cli): add parameter for trace format (plain or json)

This commit is contained in:
Kjell Winblad 2024-04-11 18:27:49 +02:00
parent 6fd7a06c5d
commit aa39835242
3 changed files with 65 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
apps/emqx/src/emqx_trace/emqx_trace_handler.erl
View File

@ -27,6 +27,7 @@
install/3, install/3,
install/4, install/4,
install/5, install/5,
install/6,
uninstall/1, uninstall/1,
uninstall/2 uninstall/2
]). ]).
@ -70,17 +71,29 @@
Type :: clientid | topic | ip_address, Type :: clientid | topic | ip_address,
Filter :: emqx_types:clientid() | emqx_types:topic() | string(), Filter :: emqx_types:clientid() | emqx_types:topic() | string(),
Level :: logger:level() | all, Level :: logger:level() | all,
LogFilePath :: string() LogFilePath :: string(),
Formatter :: plain | json
) -> ok | {error, term()}. ) -> ok | {error, term()}.
install(Name, Type, Filter, Level, LogFile) -> install(Name, Type, Filter, Level, LogFile, Formatter) ->
Who = #{ Who = #{
type => Type, type => Type,
filter => ensure_bin(Filter), filter => ensure_bin(Filter),
name => ensure_bin(Name), name => ensure_bin(Name),
payload_encode => payload_encode() payload_encode => payload_encode(),
formatter => Formatter
}, },
install(Who, Level, LogFile). install(Who, Level, LogFile).
-spec install(
Name :: binary() | list(),
Type :: clientid | topic | ip_address,
Filter :: emqx_types:clientid() | emqx_types:topic() | string(),
Level :: logger:level() | all,
LogFilePath :: string()
) -> ok | {error, term()}.
install(Name, Type, Filter, Level, LogFile) ->
install(Name, Type, Filter, Level, LogFile, plain).
-spec install( -spec install(
Type :: clientid | topic | ip_address, Type :: clientid | topic | ip_address,
Filter :: emqx_types:clientid() | emqx_types:topic() | string(), Filter :: emqx_types:clientid() | emqx_types:topic() | string(),

11
apps/emqx/src/emqx_trace/emqx_trace_json_formatter.erl
View File

@ -65,7 +65,7 @@ format_key_value_pairs([{Key, Value} | Rest], PEncode, Acc) ->
format_key(Term) -> format_key(Term) ->
%% Keys must be strings %% Keys must be strings
String = emqx_logger_textfmt:try_format_unicode(Term), String = try_format_unicode(Term),
escape(String). escape(String).
format_value(Map, PEncode) when is_map(Map) -> format_value(Map, PEncode) when is_map(Map) ->
@ -79,9 +79,16 @@ format_value(true, _PEncode) ->
format_value(false, _PEncode) -> format_value(false, _PEncode) ->
"false"; "false";
format_value(V, _PEncode) -> format_value(V, _PEncode) ->
String = emqx_logger_textfmt:try_format_unicode(V), String = try_format_unicode(V),
["\"", escape(String), "\""]. ["\"", escape(String), "\""].
try_format_unicode(undefined) ->
%% emqx_logger_textfmt:try_format_unicode converts the atom undefined to
%% the atom undefined
"undefined";
try_format_unicode(V) ->
emqx_logger_textfmt:try_format_unicode(V).
escape(IOList) -> escape(IOList) ->
Bin = iolist_to_binary(IOList), Bin = iolist_to_binary(IOList),
List = binary_to_list(Bin), List = binary_to_list(Bin),

66
apps/emqx_management/src/emqx_mgmt_cli.erl
View File

@ -507,21 +507,24 @@ trace(["list"]) ->
) )
end; end;
trace(["stop", Operation, Filter0]) -> trace(["stop", Operation, Filter0]) ->
case trace_type(Operation, Filter0) of case trace_type(Operation, Filter0, plain) of
{ok, Type, Filter} -> trace_off(Type, Filter); {ok, Type, Filter, _} -> trace_off(Type, Filter);
error -> trace([]) error -> trace([])
end; end;
trace(["start", Operation, ClientId, LogFile]) -> trace(["start", Operation, ClientId, LogFile]) ->
trace(["start", Operation, ClientId, LogFile, "all"]); trace(["start", Operation, ClientId, LogFile, "all"]);
trace(["start", Operation, Filter0, LogFile, Level]) -> trace(["start", Operation, Filter0, LogFile, Level]) ->
case trace_type(Operation, Filter0) of trace(["start", Operation, Filter0, LogFile, Level, plain]);
{ok, Type, Filter} -> trace(["start", Operation, Filter0, LogFile, Level, Formatter0]) ->
case trace_type(Operation, Filter0, Formatter0) of
{ok, Type, Filter, Formatter} ->
trace_on( trace_on(
name(Filter0), name(Filter0),
Type, Type,
Filter, Filter,
list_to_existing_atom(Level), list_to_existing_atom(Level),
LogFile LogFile,
Formatter
); );
error -> error ->
trace([]) trace([])
@ -529,19 +532,22 @@ trace(["start", Operation, Filter0, LogFile, Level]) ->
trace(_) -> trace(_) ->
emqx_ctl:usage([ emqx_ctl:usage([
{"trace list", "List all traces started on local node"}, {"trace list", "List all traces started on local node"},
{"trace start client <ClientId> <File> [<Level>]", "Traces for a client on local node"}, {"trace start client <ClientId> <File> [<Level>] [<Formatter>]",
"Traces for a client on local node (Formatter=plain|json)"},
{"trace stop client <ClientId>", "Stop tracing for a client on local node"}, {"trace stop client <ClientId>", "Stop tracing for a client on local node"},
{"trace start topic <Topic> <File> [<Level>] ", "Traces for a topic on local node"}, {"trace start topic <Topic> <File> [<Level>] [<Formatter>]",
"Traces for a topic on local node (Formatter=plain|json)"},
{"trace stop topic <Topic> ", "Stop tracing for a topic on local node"}, {"trace stop topic <Topic> ", "Stop tracing for a topic on local node"},
{"trace start ip_address <IP> <File> [<Level>] ", {"trace start ip_address <IP> <File> [<Level>] [<Formatter>]",
"Traces for a client ip on local node"}, "Traces for a client ip on local node (Formatter=plain|json)"},
{"trace stop ip_address <IP> ", "Stop tracing for a client ip on local node"}, {"trace stop ip_address <IP> ", "Stop tracing for a client ip on local node"},
{"trace start ruleid <RuleID> <File> [<Level>] ", "Traces for a rule ID on local node"}, {"trace start ruleid <RuleID> <File> [<Level>] [<Formatter>]",
"Traces for a rule ID on local node (Formatter=plain|json)"},
{"trace stop ruleid <RuleID> ", "Stop tracing for a rule ID on local node"} {"trace stop ruleid <RuleID> ", "Stop tracing for a rule ID on local node"}
]). ]).
trace_on(Name, Type, Filter, Level, LogFile) -> trace_on(Name, Type, Filter, Level, LogFile, Formatter) ->
case emqx_trace_handler:install(Name, Type, Filter, Level, LogFile) of case emqx_trace_handler:install(Name, Type, Filter, Level, LogFile, Formatter) of
ok -> ok ->
emqx_trace:check(), emqx_trace:check(),
emqx_ctl:print("trace ~s ~s successfully~n", [Filter, Name]); emqx_ctl:print("trace ~s ~s successfully~n", [Filter, Name]);
@ -592,28 +598,33 @@ traces(["delete", Name]) ->
trace_cluster_del(Name); trace_cluster_del(Name);
traces(["start", Name, Operation, Filter]) -> traces(["start", Name, Operation, Filter]) ->
traces(["start", Name, Operation, Filter, ?DEFAULT_TRACE_DURATION]); traces(["start", Name, Operation, Filter, ?DEFAULT_TRACE_DURATION]);
traces(["start", Name, Operation, Filter0, DurationS]) -> traces(["start", Name, Operation, Filter, DurationS]) ->
case trace_type(Operation, Filter0) of traces(["start", Name, Operation, Filter, DurationS, plain]);
{ok, Type, Filter} -> trace_cluster_on(Name, Type, Filter, DurationS); traces(["start", Name, Operation, Filter0, DurationS, Formatter0]) ->
case trace_type(Operation, Filter0, Formatter0) of
{ok, Type, Filter, Formatter} -> trace_cluster_on(Name, Type, Filter, DurationS, Formatter);
error -> traces([]) error -> traces([])
end; end;
traces(_) -> traces(_) ->
emqx_ctl:usage([ emqx_ctl:usage([
{"traces list", "List all cluster traces started"}, {"traces list", "List all cluster traces started"},
{"traces start <Name> client <ClientId> [<Duration>]", "Traces for a client in cluster"}, {"traces start <Name> client <ClientId> [<Duration>] [<Formatter>]",
{"traces start <Name> topic <Topic> [<Duration>]", "Traces for a topic in cluster"}, "Traces for a client in cluster (Formatter=plain|json)"},
{"traces start <Name> ip_address <IPAddr> [<Duration>]", {"traces start <Name> topic <Topic> [<Duration>] [<Formatter>]",
"Traces for a topic in cluster (Formatter=plain|json)"},
{"traces start <Name> ruleid <RuleID> [<Duration>] [<Formatter>]",
"Traces for a rule ID in cluster (Formatter=plain|json)"},
{"traces start <Name> ip_address <IPAddr> [<Duration>] [<Formatter>]",
"Traces for a client IP in cluster\n" "Traces for a client IP in cluster\n"
"Trace will start immediately on all nodes, including the core and replicant,\n" "Trace will start immediately on all nodes, including the core and replicant,\n"
"and will end after <Duration> seconds. The default value for <Duration> is " "and will end after <Duration> seconds. The default value for <Duration> is "
?DEFAULT_TRACE_DURATION ?DEFAULT_TRACE_DURATION
" seconds."}, " seconds. (Formatter=plain|json)"},
{"traces start <Name> ruleid <RuleID> [<Duration>]", "Traces for a rule ID in cluster"},
{"traces stop <Name>", "Stop trace in cluster"}, {"traces stop <Name>", "Stop trace in cluster"},
{"traces delete <Name>", "Delete trace in cluster"} {"traces delete <Name>", "Delete trace in cluster"}
]). ]).
trace_cluster_on(Name, Type, Filter, DurationS0) -> trace_cluster_on(Name, Type, Filter, DurationS0, Formatter) ->
Now = emqx_trace:now_second(), Now = emqx_trace:now_second(),
DurationS = list_to_integer(DurationS0), DurationS = list_to_integer(DurationS0),
Trace = #{ Trace = #{
@ -621,7 +632,8 @@ trace_cluster_on(Name, Type, Filter, DurationS0) ->
type => Type, type => Type,
Type => bin(Filter), Type => bin(Filter),
start_at => Now, start_at => Now,
end_at => Now + DurationS end_at => Now + DurationS,
formatter => Formatter
}, },
case emqx_trace:create(Trace) of case emqx_trace:create(Trace) of
{ok, _} -> {ok, _} ->
@ -645,10 +657,12 @@ trace_cluster_off(Name) ->
{error, Error} -> emqx_ctl:print("[error] Stop cluster_trace ~s: ~p~n", [Name, Error]) {error, Error} -> emqx_ctl:print("[error] Stop cluster_trace ~s: ~p~n", [Name, Error])
end. end.
trace_type("client", ClientId) -> {ok, clientid, bin(ClientId)}; trace_type(Op, Match, "plain") -> trace_type(Op, Match, plain);
trace_type("topic", Topic) -> {ok, topic, bin(Topic)}; trace_type(Op, Match, "json") -> trace_type(Op, Match, json);
trace_type("ip_address", IP) -> {ok, ip_address, IP}; trace_type("client", ClientId, Formatter) -> {ok, clientid, bin(ClientId), Formatter};
trace_type(_, _) -> error. trace_type("topic", Topic, Formatter) -> {ok, topic, bin(Topic), Formatter};
trace_type("ip_address", IP, Formatter) -> {ok, ip_address, IP, Formatter};
trace_type(_, _, _) -> error.
%%-------------------------------------------------------------------- %%--------------------------------------------------------------------
%% @doc Listeners Command %% @doc Listeners Command