Move the Erlang services off lager onto OTP logger

src/bookshelf/rebar.config

@@ -7,9 +7,6 @@
 {erl_dep_retries, 10}.
 
 {deps, [
-    %% lager has to come first since we use its parse transform
-    {lager, ".*",
-        {git, "https://github.com/erlang-lager/lager",              {branch, "master"}}},
     {cf, "",
         {git, "https://github.com/project-fifo/cf",                 {branch, "master"}}},
     {chef_secrets, ".*",
@@ -46,7 +43,6 @@
 
 {erl_opts, [
     debug_info,
-    {parse_transform, lager_transform},
     warnings_as_errors,
     {i, "include"}
 ]}.

src/bookshelf/src/bksw_cleanup_task.erl

@@ -19,6 +19,8 @@
 %%
 
 -module(bksw_cleanup_task).
+
+-include_lib("kernel/include/logger.hrl").
 -behaviour(gen_server).
 
 -export([start_link/0]).
@@ -79,20 +81,20 @@ code_change(_OldVsn, State, _Extra) ->
 do_delete_cleanup(#state{deleted_cleanup_interval = Interval}) ->
     case sqerl:select(purge_expired, [Interval], first_as_scalar, [purge_expired]) of
         {ok, Count} ->
-            lager:debug("Cleanup task: cleaned up ~p expired file_data elements", [Count]),
+            ?LOG_DEBUG("Cleanup task: cleaned up ~p expired file_data elements", [Count]),
             Count;
         _Error ->
-            lager:debug("Cleanup task: error cleaning up expired file_data elements", []),
+            ?LOG_DEBUG("Cleanup task: error cleaning up expired file_data elements", []),
             0
     end.
 
 do_upload_cleanup(#state{upload_cleanup_interval = Interval}) ->
     case sqerl:select(cleanup_abandoned_uploads, [Interval], first_as_scalar, [cleanup_abandoned_uploads]) of
         {ok, Count} ->
-            lager:debug("Cleanup task: cleaned up ~p expired file_data elements", [Count]),
+            ?LOG_DEBUG("Cleanup task: cleaned up ~p expired file_data elements", [Count]),
             Count;
         _Error ->
-            lager:debug("Cleanup task: error cleaning up expired file_data elements", []),
+            ?LOG_DEBUG("Cleanup task: error cleaning up expired file_data elements", []),
             0
     end.
 

src/bookshelf/src/bksw_sup.erl

@@ -21,6 +21,8 @@
 
 -module(bksw_sup).
 
+-include_lib("kernel/include/logger.hrl").
+
 -behaviour(supervisor).
 
 -export([start_link/0]).
@@ -71,9 +73,9 @@ ensure_default_bucket() ->
     DefaultBucket = <<"bookshelf">>,
     case bksw_sql:bucket_exists(DefaultBucket) of
         true ->
-            lager:info("Default bucket ~p already exists.", [DefaultBucket]),
+            ?LOG_INFO("Default bucket ~p already exists.", [DefaultBucket]),
             ok;
         false ->
-            lager:info("Create default bucket ~p.", [DefaultBucket]),
+            ?LOG_INFO("Create default bucket ~p.", [DefaultBucket]),
             bksw_sql:create_bucket(DefaultBucket)
     end.

src/bookshelf/src/bksw_wm_sql_object.erl

@@ -218,7 +218,7 @@ send_streamed_body(#context{entry_md = #db_file{chunk_count = ChunkCount, hash_s
         ShaExpected ->
             ok;
         S ->
-            lager:error("checksum mismatch on download: expected: ~p; sent: ~p", [ShaExpected, S])
+            ?LOG_ERROR("checksum mismatch on download: expected: ~p; sent: ~p", [ShaExpected, S])
     end,
     {<<>>, done};
 send_streamed_body(#context{entry_md = #db_file{data_id = DataId} = DbFile,
@@ -324,7 +324,7 @@ write_streamed_body({Data, done}, Rq0,
                     ok = finalize_maybe_create_file(Rq1, Ctx0, File1),
                     {{halt, 204}, Rq1, Ctx1};
                 _ ->
-                    lager:error("Mismatch between Content-MD5 and actual content. Content-MD5: ~p; Actual: ~p", [RequestMd5, HashMd5]),
+                    ?LOG_ERROR("Mismatch between Content-MD5 and actual content. Content-MD5: ~p; Actual: ~p", [RequestMd5, HashMd5]),
                     %% Exiting here causes uploads to be abandoned, but the upload_cleanup task will
                     %% eventually clean things up.
                     {{halt, 406}, Rq0, Ctx1}

src/bookshelf/src/bookshelf.app.src

@@ -34,7 +34,6 @@
                     erlsom,
                     mini_s3,
                     inets,
-                    lager,
                     envy,
                     opscoderl_wm,
                     iso8601,

src/bookshelf/src/internal.hrl

@@ -26,17 +26,11 @@
 -define(PGSQL_RETRY_INTERVAL, 5).
 
 %% logging utilities
--compile([{parse_transform, lager_transform}]).
-%% For general info and error logging, we use error_logger and take advantage of lager's
-%% error_logger handler. The main benefit is seeing the logs via sasl instead of lager for
-%% common test. We _could_ take this approach to make lager a soft dependency, but once you
-%% want to add debug-level logging you need direct lager calls.
--define(LOG_INFO(X, Y), error_logger:info_msg(X, Y)).
--define(LOG_INFO(X), error_logger:info_msg(X)).
--define(LOG_ERROR(X, Y), error_logger:error_msg(X, Y)).
--define(LOG_ERROR(X), error_logger:error_msg(X)).
--define(LOG_DEBUG(X, Y), lager:debug(X, Y)).
--define(LOG_DEBUG(X), lager:debug(X)).
+%% OTP's logger provides ?LOG_INFO/?LOG_ERROR/?LOG_DEBUG at the same arities
+%% the lager/error_logger definitions it replaces did, so every existing call
+%% site is unchanged. The macros (rather than logger:Level/2 calls) are what
+%% capture module, function and line -- the job lager's parse transform did.
+-include_lib("kernel/include/logger.hrl").
 
 -include("bksw_obj.hrl").
 

src/bookshelf/test/bkswt_api_SUITE.erl

@@ -111,11 +111,6 @@ start_bookshelf() ->
     %% it from the ?APPS list so that we don't start/stop on each test.
     application:start(sasl),
 
-    %% we start lager since we depend on it for the release. However,
-    %% we want to keep error_logger on its own so that we continue to
-    %% see messages in common test output.
-    lager_common_test_backend:bounce(error),
-
     case application:ensure_all_started(bookshelf) of
         {ok, Apps} ->
             {ok, Apps};

src/oc_bifrost/apps/bifrost/src/bifrost.app.src

@@ -16,7 +16,6 @@
   %% manually in bifrost_app.erl.)
   {applications, [kernel,
                   stdlib,
-                  lager,
                   sasl,
                   stats_hero,
                   ej,

src/oc_bifrost/apps/bifrost/src/bifrost_wm_base.erl

@@ -1,5 +1,7 @@
 -module(bifrost_wm_base).
 
+-include_lib("kernel/include/logger.hrl").
+
 -export([content_types_accepted/2,
          content_types_provided/2,
          create_path/2,
@@ -178,7 +180,7 @@ spawn_stats_hero_worker(Req, #base_state{reqid=ReqId,
             ok;
         {error, Reason} ->
             %% TODO: Need to put this to a separate file
-            lager:error(io_lib:format("FAILED stats_hero_worker_sup:new_worker: ~p~n", [Reason])),
+            ?LOG_ERROR(io_lib:format("FAILED stats_hero_worker_sup:new_worker: ~p~n", [Reason])),
             ok
     end.
 

src/oc_bifrost/apps/bifrost/src/bifrost_wm_status_resource.erl

@@ -1,5 +1,7 @@
 -module(bifrost_wm_status_resource).
 
+-include_lib("kernel/include/logger.hrl").
+
 -export([
          allowed_methods/2,
          content_types_provided/2,
@@ -24,6 +26,6 @@ to_json(Req, State) ->
         ok ->
             {<<"{\"status\": \"ok\"}">>, Req, State};
         {error, Reason} ->
-            lager:error(io_lib:format("status check: ~999p~n", [Reason])),
+            ?LOG_ERROR(io_lib:format("status check: ~999p~n", [Reason])),
             {{halt, 500}, Req, State}
     end.

src/oc_bifrost/rebar.config

@@ -4,17 +4,13 @@
 
 {erl_opts, [
             warnings_as_errors,
-            {parse_transform, lager_transform},
             debug_info
            ]}.
 {erl_first_files, ["src/bifrost_wm.erl"]}.
 
 {require_otp_vsn, "26.2.5.21"}.
 
 {deps, [
-    %% lager has to come first since we use its parse transform
-    {lager, ".*",
-        {git, "https://github.com/erlang-lager/lager",                  {branch, "master"}}},
     {chef_secrets, ".*",
         {git, "https://github.com/chef/chef_secrets",                   {branch, "main"}}},
     {edown, ".*",
@@ -102,7 +98,6 @@
         envy,
         sqerl,
         stats_hero,
-        lager,
         bifrost
    ]},
 

src/oc_erchef/apps/chef_index/src/chef_index.erl

@@ -17,6 +17,8 @@
 
 -module(chef_index).
 
+-include_lib("kernel/include/logger.hrl").
+
 -export([search/1,
          update/1,
          update/2,
@@ -140,7 +142,7 @@ add_batch_item_with_retries(Item, Failures, Max) ->
             Error;
         Error ->
             Retries = Failures + 1,
-            lager:warning("chef_index:add failed for ~s[~s]: ~p retrying (~p/~p)", [TypeName, Id, Error, Retries, Max]),
+            ?LOG_WARNING("chef_index:add failed for ~s[~s]: ~p retrying (~p/~p)", [TypeName, Id, Error, Retries, Max]),
             wait_before_retry(),
             add_batch_item_with_retries(Item, Retries, Max)
     end.
@@ -153,14 +155,14 @@ wait_before_retry() ->
 wait_before_retry(0, 0) ->
     ok;
 wait_before_retry(Min, Min) ->
-    lager:info("chef_index: waiting ~B ms before retry", [Min]),
+    ?LOG_INFO("chef_index: waiting ~B ms before retry", [Min]),
     timer:sleep(Min);
 wait_before_retry(Min, Max) when Min > Max ->
-    lager:error("chef_index: reindex_sleep_max_ms less than reindex_sleep_min_ms. Sleeping ~B", [Max]),
+    ?LOG_ERROR("chef_index: reindex_sleep_max_ms less than reindex_sleep_min_ms. Sleeping ~B", [Max]),
     timer:sleep(Max);
 wait_before_retry(Min, Max) ->
     RandMinMax = Min + rand:uniform(Max - Min),
-    lager:info("chef_index: waiting ~B ms before retry", [RandMinMax]),
+    ?LOG_INFO("chef_index: waiting ~B ms before retry", [RandMinMax]),
     timer:sleep(RandMinMax).
 
 not_ok(Results) ->

src/oc_erchef/apps/chef_index/src/chef_index_batch.erl

@@ -16,6 +16,8 @@
 %%
 
 -module(chef_index_batch).
+
+-include_lib("kernel/include/logger.hrl").
 -behaviour(gen_server).
 
 -ifdef(TEST).
@@ -179,7 +181,7 @@ flush(State = #chef_idx_batch_state{item_queue = Queue,
     spawn(
       fun() ->
               prometheus_gauge:inc(chef_index_batch_inflight_flushes_count),
-              lager:debug("Batch posting to ~s ~p documents (~p bytes)", [Provider, length(DocsToAdd), CurrentSize + WrapperSize]),
+              ?LOG_DEBUG("Batch posting to ~s ~p documents (~p bytes)", [Provider, length(DocsToAdd), CurrentSize + WrapperSize]),
               Now = erlang:monotonic_time(),
               Res = chef_index:update(Provider, Doc),
               Now1 = erlang:monotonic_time(),
@@ -238,7 +240,7 @@ handle_call(stats, _From, State = #chef_idx_batch_state{avg_queue_latency = OQL,
             ],
     {reply, Stats, State};
 handle_call(stop, From, State) ->
-    lager:info("Stop requested from ~p", [From]),
+    ?LOG_INFO("Stop requested from ~p", [From]),
     {stop, normal, ok, State};
 handle_call(_Request, _From, State) ->
     Reply = ok,
@@ -257,7 +259,7 @@ collect_process_info() ->
             prometheus_gauge:set(chef_index_batch_memory_size_bytes, MemorySizeBytes),
             prometheus_gauge:set(chef_index_batch_mailbox_size, MailboxSize);
         Other ->
-            lager:warning("unexpected process_info reponse: ~w", [Other])
+            ?LOG_WARNING("unexpected process_info reponse: ~w", [Other])
     end.
 
 

src/oc_erchef/apps/chef_index/src/chef_wait_group.erl

@@ -16,6 +16,8 @@
 %%
 -module(chef_wait_group).
 
+-include_lib("kernel/include/logger.hrl").
+
 -behaviour(gen_server).
 
 %% API Exports
@@ -124,7 +126,7 @@ handle_call(get_state, _From, State) ->
 handle_info({'EXIT', _From, normal}, State) ->
     {noreply, State};
 handle_info({'EXIT', From, Reason}, State) ->
-    lager:error("Worker ~p failed unexpectedly: ~p", [From, Reason]),
+    ?LOG_ERROR("Worker ~p failed unexpectedly: ~p", [From, Reason]),
     State1 = mark_job_failed(From, {worker_failed, Reason}, State),
     case maybe_reply_to_waiter(State1) of
         true ->

src/oc_erchef/apps/chef_license/src/chef_license_worker.erl

@@ -1,5 +1,7 @@
 -module(chef_license_worker).
 
+-include_lib("kernel/include/logger.hrl").
+
 -behaviour(gen_server).
 
 -include("../../../include/chef_types.hrl").
@@ -120,21 +122,21 @@ get_license_info(InstallTime, cli) ->
       case catch jiffy:decode(Bin) of
         {Json} -> Json;
         _ ->
-          lager:warning("CLI license check returned invalid JSON, falling back to default license"),
+          ?LOG_WARNING("CLI license check returned invalid JSON, falling back to default license"),
           make_license_payload(InstallTime, #{})
       end;
     {error, Reason} ->
-      lager:debug("CLI license file not found (~p), falling back to default license", [Reason]),
+      ?LOG_DEBUG("CLI license file not found (~p), falling back to default license", [Reason]),
       make_license_payload(InstallTime, #{})
   end;
 % This is for the file-based license mode, where we read the license directly from a file path.
 get_license_info(InstallTime, Path) ->
   case load_local_license(InstallTime, Path) of
     {ok, Json} ->
-      lager:debug("Loaded local license data: ~p", [Json]),
+      ?LOG_DEBUG("Loaded local license data: ~p", [Json]),
       Json;
     {error, Reason} ->
-      lager:warning("Failed to load local license, falling back to default: ~p", [Reason]),
+      ?LOG_WARNING("Failed to load local license, falling back to default: ~p", [Reason]),
       make_license_payload(InstallTime, #{})
   end.
 
@@ -200,7 +202,7 @@ make_license_payload(InstallTime, _Other) ->
   %% If we don't have the expected fields, we don't have a valid license - so let's make something that looks like one,
   %% but is valid from the install date + 90 days.
   ExpirationTime = InstallTime + (60 * 60 * 24 * 90), % 90 days from install time
-  lager:debug("License payload is missing expected fields, treating as valid license with expiration : ~p", [ExpirationTime]),
+  ?LOG_DEBUG("License payload is missing expected fields, treating as valid license with expiration : ~p", [ExpirationTime]),
   [ {<<"result">>, {[
                     {<<"license_id">>, <<>>},
                     {<<"customer_name">>, <<>>},
@@ -220,7 +222,7 @@ check_license(#state{install_time = InstallTime} = State,  ModeOrPath) ->
   JsonStr = case catch get_license_info(InstallTime, ModeOrPath) of
               Result when is_list(Result) -> Result;
               {'EXIT', N} ->
-                lager:error("License check failed with exit: ~p", [N]),
+                ?LOG_ERROR("License check failed with exit: ~p", [N]),
                 <<"">>
             end,
   case process_license(JsonStr) of

src/oc_erchef/apps/chef_objects/src/chef_cbv_cache.erl

@@ -21,6 +21,8 @@
 %%
 
 -module(chef_cbv_cache).
+
+-include_lib("kernel/include/logger.hrl").
 -behavior(gen_server).
 
 -define(SERVER, ?MODULE).
@@ -206,7 +208,7 @@ handle_info({expire, Key}, #state{tid = Tid} = State) ->
     ets:delete(Tid, Key),
     {noreply, State};
 handle_info({'EXIT', _From, Reason}, State) ->
-    lager:error("chef_cbv_cache: circuit breaker proc failed because ~p, restarting", [Reason]),
+    ?LOG_ERROR("chef_cbv_cache: circuit breaker proc failed because ~p, restarting", [Reason]),
     spawn_breaker(),
     {noreply, State};
 handle_info(_Info, State) ->
@@ -242,7 +244,7 @@ insert_into_cache(Tid, Key, Value, TTL) ->
         false ->
             % Value already exists.  Given the enforced ordering to prevent more than
             % one caller from trying to put the same key, this should no longer be possible
-            lager:info("chef_cbv_cache: Key ~p already present, ignoring.", [Key])
+            ?LOG_INFO("chef_cbv_cache: Key ~p already present, ignoring.", [Key])
     end.
 
 spawn_breaker() ->

src/oc_erchef/apps/chef_telemetry/rebar.config

@@ -4,9 +4,6 @@
 
 {deps,
     [
-    %% lager has to come first since we use its parse transform
-    {lager, ".*",
-        {git, "https://github.com/erlang-lager/lager",                {branch, "master"}}}
     ]
 }.
 
@@ -19,7 +16,6 @@
 
 {erl_opts, [
     warnings_as_errors,
-    {parse_transform, lager_transform},
     debug_info
 ]}.
 

src/oc_erchef/apps/chef_telemetry/src/chef_telemetry.app.src

@@ -26,7 +26,6 @@
     {applications, [
         kernel,
         stdlib,
-        lager,
         chef_secrets,
         opscoderl_httpc
     ]},