fx: 代码整理

eLog.sample.config

@@ -71,19 +71,19 @@
       {crashLogDate, <<"$D0">>},
       %% 要保留的已轮转崩溃日志的数量，0表示仅保留当前的一个-默认值为0
       {crashLogCount, 0},
-      %% 崩溃日志旋转器模块-默认为lager_rotator_default
+      %% 崩溃日志旋转器模块-默认为lgRotatorIns
       {crashLogRotator, lgRotatorIns},
 
       %% **********************************************  error_logger相关  **********************************************
       %% 是否将error_logger消息重定向到默认的eLog_event接收器-默认为true
       {errLoggerRedirect, true},
-      %% 列表中的handler 不会处理error_logger
+      %% 列表中的handler 不会从error_logger  handler列表中移除
       {errLoggerWhitelist, []},
       %% 每秒允许来自error_logger的消息数量是多少 超过就丢弃掉 值为undefined禁止抛弃
       {errLoggerHwm, undefined},
       %% errLogger group leader策略 handle | ignore | mirror
       {errLoggerGLS, handle},
-      %%是否禁止 disable reformatting for OTP and Cowboy messages
+      %%是否禁止 disable reformatting for OTP and Cowboy messages   false表示会格式化OTP和Cowboy的错误信息
       {errLoggerFmtRaw, false},
       %% 超过高水位标记时，可以将啤酒配置为刷新消息队列中的所有事件通知
       {errLoggerFlushQueue, true},

include/lgDef.hrl

@@ -137,7 +137,7 @@
       fun() ->
          case catch (gen_emm:which_epm(?LgDefSink)) of
             X when X == []; X == {'EXIT', noproc}; X == [lgBkdThrottle] ->
-               %% there's no handlers yet or lager isn't running, try again
+               %% there's no handlers yet or eLog isn't running, try again
                %% in half a second.
                timer:sleep(500),
                ?LgNotify(Level, Self, Format, Args);

rebar.config

@@ -25,7 +25,4 @@
    {apps, [eLog]}
 ]}.
 
-{xref_checks, []}.
-{xref_queries, [{"(XC - UC) || (XU - X - B - lager_default_tracer : Mod - erlang:\"(is_map|map_size)\"/1 - maps:to_list/1)", []}]}.
-
 {cover_enabled, true}.

src/backend/lgBkdConsole.erl

@@ -12,7 +12,7 @@
 -compile(inline).
 -compile({inline_size, 128}).
 
--define(TERSE_FORMAT, [datetime, <<" ">>, color, sev, message]).
+-define(TERSE_FORMAT, [datetime, <<" ">>, color, sev, <<" ">>, message]).
 -define(LgDefConsoleFmtCfg, ?TERSE_FORMAT ++ [eol()]).
 -define(LgDefConsoleOpts, [{use_stderr, false}, {group_leader, false}, {id, ?MODULE}, {fmtTer, ?LgDefFmtTer}, {fmtCfg, ?LgDefConsoleFmtCfg}]).
 

src/backend/lgBkdFile.erl

@@ -232,7 +232,7 @@ isWriteCheck(Fd, LastCheck, CheckInt, Name, Inode, CTime, Timestamp) ->
       true ->
          true;
       _ ->
-         % We need to know if the file has changed "out from under lager" so we don't write to an invalid Fd
+         % We need to know if the file has changed "out from under eLog" so we don't write to an invalid Fd
          {Result, _FInfo} = lgUtil:isFileChanged(Name, Inode, CTime),
          Result
    end.

src/crashLog/lgCrashLog.erl

@@ -124,14 +124,6 @@ perhapsSaslReport(error_report, {Pid, Type, Report}, FmtMaxBytes) ->
       false ->
          {ignore, ignore, ignore, false}
    end;
-%perhaps_a_sasl_report(info_report, {Pid, Type, Report}, FmtMaxBytes) ->
-%case lager_stdlib:is_my_info_report(Type) of
-%true ->
-%{sasl_type_to_report_head(Type), Pid,
-%sasl_limited_str(Type, Report, FmtMaxBytes), false};
-%false ->
-%{ignore, ignore, ignore, false}
-%end;
 perhapsSaslReport(_, _, _) ->
    {ignore, ignore, ignore, false}.
 

src/eLog.erl

@@ -105,7 +105,7 @@ doLogImpl(Severity, Pid, Node, Module, Function, Line, Metadata, Format, Args, S
          gen_emm:info_notify(TraceSinkPid, {mWriteLog, LgMsg})
    end.
 
-%% @doc Get lager metadata for current process
+%% @doc Get metadata for current process
 -spec getMd() -> [{atom(), any()}].
 getMd() ->
    case erlang:get(?PdMdKey) of
@@ -113,7 +113,7 @@ getMd() ->
       MD -> MD
    end.
 
-%% @doc Set lager metadata for current process.
+%% @doc Set metadata for current process.
 %% Will badarg if you don't supply a list of {key, value} tuples keyed by atoms.
 -spec setMd([{atom(), any()}, ...]) -> ok.
 setMd(NewMD) when is_list(NewMD) ->
@@ -185,7 +185,7 @@ setLogHwm(Sink, Handler, Ident, Hwm) when is_integer(Hwm) ->
 %% @doc recalculate min log level
 upLogLevelCfg(error_logger) ->
    %% Not a sink under our control, part of the Erlang logging
-   %% utility that error_logger_lager_h attaches to
+   %% utility that lg attaches to
    true;
 upLogLevelCfg(Sink) ->
    Traces = lgConfig:ptGet({Sink, trace}, []),
@@ -369,7 +369,7 @@ stopTraceInt({_Filter, _Level, Backend} = Trace, Sink) ->
    end,
    ok.
 
-%% @doc installs a lager trace handler into the target process (using sys:install) at the specified level.
+%% @doc installs a eLog trace handler into the target process (using sys:install) at the specified level.
 -spec installTrace(pid(), lgAtomLevel()) -> ok.
 installTrace(Pid, Level) ->
    installTrace(Pid, Level, []).
@@ -378,7 +378,7 @@ installTrace(Pid, Level) ->
 installTrace(Pid, Level, Options) ->
    sys:install(Pid, {fun ?MODULE:traceFunc/3, traceState(Pid, Level, Options)}).
 
-%% @doc remove a previously installed lager trace handler from the target process.
+%% @doc remove a previously installed eLog trace handler from the target process.
 -spec removeTrace(pid()) -> ok.
 removeTrace(Pid) ->
    sys:remove(Pid, fun ?MODULE:traceFunc/3).

src/eLog_app.erl

@@ -155,8 +155,8 @@ tryStartErrLoggerHandler(_ErrLoggerRedirect, Hwm, WhiteList) ->
          ok
    end,
 
-   %% capture which handlers we removed from error_logger so we can restore them when lager stops
-   %% 捕获从error_logger中删除的处理程序，以便在lager停止时恢复它们
+   %% capture which handlers we removed from error_logger so we can restore them when eLog stops
+   %% 捕获从error_logger中删除的处理程序，以便在eLog停止时恢复它们
    OldHandlers =
       case supervisor:start_child(lgHWatcherSup, [error_logger, lgErrLoggerH, [Hwm, lgUtil:get_env(errLoggerGLS, handle)]]) of
          {ok, _} ->

src/errLogger/lgErrLoggerH.erl

@@ -104,7 +104,7 @@ handle_event(Event, #state{sink = Sink, shaper = Shaper} = State) ->
             true ->
                {ok, State#state{shaper = NewShaper}};
             _ ->
-               ?LOGFMT(Sink, ?warning, self(), "lager_error_logger_h dropped ~p messages in the last second that exceeded the limit of ~p messages/sec", [Drop, NewShaper#lgShaper.hwm]),
+               ?LOGFMT(Sink, ?warning, self(), "lgErrLoggerH dropped ~p messages in the last second that exceeded the limit of ~p messages/sec", [Drop, NewShaper#lgShaper.hwm]),
                evalGl(Event, State#state{shaper = NewShaper})
          end;
       {false, _, NewShaper} ->
@@ -116,7 +116,7 @@ handle_info({mShaperExpired, ?MODULE}, #state{sink = Sink, shaper = Shaper} = St
       0 ->
          ignore;
       Dropped ->
-         ?LOGFMT(Sink, ?warning, self(), "lager_error_logger_h dropped ~p messages in the last second that exceeded the limit of ~p messages/sec", [Dropped, Shaper#lgShaper.hwm])
+         ?LOGFMT(Sink, ?warning, self(), "lgErrLoggerH dropped ~p messages in the last second that exceeded the limit of ~p messages/sec", [Dropped, Shaper#lgShaper.hwm])
    end,
    {ok, State#state{shaper = Shaper#lgShaper{dropped = 0}}};
 handle_info(_Info, State) ->
@@ -381,7 +381,7 @@ formatCrashReport(Report, Neighbours) ->
             %% process_info(Pid, registered_name) returns [] for unregistered processes
             [];
          Dict ->
-            %% pull the lager metadata out of the process dictionary, if we can
+            %% pull the eLog metadata out of the process dictionary, if we can
             get_value(?PdMdKey, Dict, [])
       end,
 

src/utils/lgUtil.erl

@@ -499,7 +499,7 @@ parsePath(FBName) ->
 
 %% Find a file among the already installed handlers.
 %%
-%% The file is already expanded (i.e. lager_util:expand_path already added the
+%% The file is already expanded (i.e. lgUtil:expand_path already added the
 %% "logRoot"), but the file paths inside Handlers are not.
 find_file(_File1, _Handlers = []) ->
    false;
@@ -588,8 +588,8 @@ dropMsg(LastTime, Filter, Count) ->
    end.
 
 %% @private Build an atom for the gen_event process based on a sink name.
-%% For historical reasons, the default gen_event process for lager itself is named
-%% `lager_event'. For all other sinks, it is SinkName++`_lager_event'
+%% For historical reasons, the default gen_event process for eLog itself is named
+%% `eLogEvent'. For all other sinks, it is SinkName++`_lgEvent'
 makeInnerSinkName(Sink) ->
    binary_to_atom(<<(atom_to_binary(Sink, utf8))/binary, "Event">>).
 

src/watcher/lgHWatcherSrv.erl

@@ -58,7 +58,7 @@ handleInfo({gen_event_EXIT, Module, {'EXIT', {kill_me, [_KillerHwm, KillerReinst
    {_, Len} = process_info(SinkPid, message_queue_len),
    error_logger:error_msg("Killing sink ~p, current message_queue_len:~p~n", [Sink, Len]),
    exit(SinkPid, kill),
-   _ = timer:apply_after(KillerReinstallAfter, lager_app, start_handler, [Sink, Module, Config]),
+   _ = timer:apply_after(KillerReinstallAfter, eLog_app, startHandler, [Sink, Module, Config]),
    {stop, normal, State};
 handleInfo({gen_event_EXIT, Module, Reason}, #state{module = Module, config = Config, sink = Sink} = State) ->
    case ?LgShouldLog(?error) of
@@ -97,7 +97,7 @@ installHandler(Module, Config, Sink) ->
          lgErrLoggerH ->
             gen_event:add_sup_handler(Sink, Module, Config);
          lgBkThrottle ->
-            %% lager_backend_throttle需要知道它连接到哪个接收器，因此这个公认的丑陋的解决方案。处理程序对发送到' init'的配置结构是敏感的，
+            %% lgBkdThrottle需要知道它连接到哪个接收器，因此这个公认的丑陋的解决方案。处理程序对发送到' init'的配置结构是敏感的，
             %% 遗憾的是，在不破坏第三方处理程序的情况下，向后端添加一个要忽略的配置项并不是一件小事。
             gen_emm:add_sup_epm(Sink, Module, [{sink, Sink} | Config]);
          _ ->