File 0001-Turn-repeated-errors-into-notice-and-repla... of Package eredis

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-Turn-repeated-errors-into-notice-and-replace-error_l.patch of Package eredis

From af7a2550383214353430665a3e46184ac8b1812a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Viktor=20S=C3=B6derqvist?= <viktor.soderqvist@est.tech>
Date: Wed, 27 Jul 2022 10:43:00 +0200
Subject: [PATCH] Turn repeated errors into notice and replace error_logger
 with logger (#71)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Björn Svensson <bjorn.a.svensson@est.tech>
---
 src/eredis_client.erl   | 48 +++++++++++++++++++++++++----------------
 src/eredis_sentinel.erl |  9 +++++---
 2 files changed, 36 insertions(+), 21 deletions(-)

diff --git a/src/eredis_client.erl b/src/eredis_client.erl
index a633515..89e4776 100644
--- a/src/eredis_client.erl
+++ b/src/eredis_client.erl
@@ -24,6 +24,7 @@
 -module(eredis_client).
 -behaviour(gen_server).
 -include("eredis.hrl").
+-include_lib("kernel/include/logger.hrl").
 
 -define(CONNECT_TIMEOUT, 5000).
 -define(RECONNECT_SLEEP, 100).
@@ -230,13 +231,14 @@ handle_info(initiate_connection, #state{socket = undefined} = State) ->
         {ok, NewState} ->
             {noreply, NewState};
         {error, Reason} ->
-            {noreply, schedule_reconnect(Reason, State)}
+            ?LOG_WARNING("eredis: Initial connect failed: ~p", [Reason]),
+            {noreply, schedule_reconnect(State)}
     end;
 
-handle_info({reconnect, Reason}, #state{socket = undefined} = State) ->
+handle_info(reconnect, #state{socket = undefined} = State) ->
     %% Scheduled reconnect, if disconnected.
-    maybe_reconnect(Reason, State#state{reconnect_timer = undefined});
-handle_info({reconnect, _Reason}, State) ->
+    maybe_reconnect(retry, State#state{reconnect_timer = undefined});
+handle_info(reconnect, State) ->
     %% Already connected.
     {noreply, State#state{reconnect_timer = undefined}};
 
@@ -336,7 +338,7 @@ reply(Value, Queue) ->
             queue:in_r({N - 1, From, [Value | Replies]}, NewQueue);
         {empty, Queue} ->
             %% Oops
-            error_logger:info_msg("eredis: Nothing in queue, but got value from parser~n"),
+            ?LOG_NOTICE("eredis: Nothing in queue, but got value from parser"),
             exit(empty_queue)
     end.
 
@@ -368,7 +370,8 @@ safe_send(Pid, Value) ->
     try erlang:send(Pid, Value)
     catch
         Err:Reason ->
-            error_logger:info_msg("eredis: Failed to send message to ~p with reason ~p~n", [Pid, {Err, Reason}])
+            ?LOG_NOTICE("eredis: Failed to send message to ~p with reason ~p",
+                        [Pid, {Err, Reason}])
     end.
 
 %% @doc: Helper for connecting to Redis, authenticating and selecting
@@ -408,7 +411,7 @@ connect(#state{host = Host0,
                     %% an expired certificate with TLS 1.3) schedule a reconnect already
                     %% so that we don't try to reconnect if an error is received before
                     %% reconnect_sleep milliseconds has elapsed.
-                    {ok, schedule_reconnect(unknown, State#state{socket = Socket})};
+                    {ok, schedule_reconnect(State#state{socket = Socket})};
                 Error ->
                     Error
             end
@@ -567,17 +570,18 @@ close_socket(#state{socket = Socket, transport = Transport} = State) ->
     State#state{socket = undefined}.
 
 %% @doc Schedules a reconnect attempt, if reconnect is enabled.
--spec schedule_reconnect(Reason :: any(), #state{}) -> #state{}.
-schedule_reconnect(_Reason, #state{reconnect_sleep = no_reconnect} = State) ->
+-spec schedule_reconnect(#state{}) -> #state{}.
+schedule_reconnect(#state{reconnect_sleep = no_reconnect} = State) ->
     State;
-schedule_reconnect(Reason, #state{reconnect_sleep = ReconnectSleep,
-                                  reconnect_timer = undefined} = State) ->
-    TRef = erlang:send_after(ReconnectSleep, self(), {reconnect, Reason}),
+schedule_reconnect(#state{reconnect_sleep = ReconnectSleep,
+                          reconnect_timer = undefined} = State) ->
+    TRef = erlang:send_after(ReconnectSleep, self(), reconnect),
     State#state{reconnect_timer = TRef}.
 
-%% @doc Reconnects, but not if a reconnect has been scheduled or if reconnect is
-%% disabled. The socket in the state is closed, if any. Returns {noreply, State}
-%% or {stop, ExitReason, State} like handle_info.
+%% @doc Logs a lost connection error with Reason and potentially reconnects or
+%% schedules a reconnect, depending on options. The socket in the state is
+%% closed, if any. Returns {noreply, State} or {stop, ExitReason, State} like
+%% handle_info.
 maybe_reconnect(Reason, #state{reconnect_sleep = no_reconnect, queue = Queue} = State) ->
     reply_all({error, Reason}, Queue),
     %% If we aren't going to reconnect, then there is nothing else for
@@ -593,8 +597,8 @@ maybe_reconnect(Reason,
                        host = Host,
                        port = Port,
                        reconnect_timer = undefined} = State) ->
-    error_logger:error_msg("eredis: Re-establishing connection to ~p:~p due to ~p",
-                           [Host, Port, Reason]),
+    log_reconnect(Reason, Host, Port),
+
     %% Tell all of our clients what has happened.
     reply_all({error, Reason}, Queue),
 
@@ -606,9 +610,17 @@ maybe_reconnect(Reason,
         {ok, State2} ->
             {noreply, State2};
         {error, NewReason} ->
-            {noreply, schedule_reconnect(NewReason, State1)}
+            ?LOG_NOTICE("eredis: Reconnect failed: ~p", [NewReason]),
+            {noreply, schedule_reconnect(State1)}
     end.
 
+log_reconnect(retry, _Host, _Port) ->
+    %% Don't flood the log for every retry, in case the Redis node is down.
+    ok;
+log_reconnect(Reason, Host, Port) ->
+    ?LOG_WARNING("eredis: Re-establishing connection to ~p:~p due to ~p",
+                 [Host, Port, Reason]).
+
 read_database(undefined) ->
     undefined;
 read_database(Database) when is_integer(Database) ->
diff --git a/src/eredis_sentinel.erl b/src/eredis_sentinel.erl
index 7a286a1..daec97d 100644
--- a/src/eredis_sentinel.erl
+++ b/src/eredis_sentinel.erl
@@ -2,6 +2,7 @@
 -module(eredis_sentinel).
 -behaviour(gen_server).
 -include("eredis.hrl").
+-include_lib("kernel/include/logger.hrl").
 
 %% API
 -export([start_link/2, stop/1, get_master/1]).
@@ -190,7 +191,7 @@ query_master(#eredis_sentinel_state{conn_pid=undefined,
         {ok, ConnPid} ->
             query_master(S#eredis_sentinel_state{conn_pid=ConnPid});
         {error, E} ->
-            error_logger:error_msg("Error connecting to sentinel at ~p:~p : ~p~n", [H, P, E]),
+            ?LOG_WARNING("Error connecting to sentinel at ~p:~p : ~p", [H, P, E]),
             Errors = update_errors(?SENTINEL_UNREACHABLE, S#eredis_sentinel_state.errors),
             Sentinels = rotate(S#eredis_sentinel_state.endpoints),
             query_master(S#eredis_sentinel_state{endpoints = Sentinels, errors = Errors})
@@ -203,7 +204,8 @@ query_master(#eredis_sentinel_state{conn_pid=ConnPid,
         {ok, HostPort} ->
             {ok, HostPort, S};
         {error, Error} ->
-            error_logger:error_msg("Master request for ~p to sentinel ~p:~p failed with ~p~n", [MasterGroup, H, P, Error]),
+            ?LOG_WARNING("Master request for ~p to sentinel ~p:~p failed with ~p",
+                         [MasterGroup, H, P, Error]),
             eredis:stop(ConnPid),
             Errors = update_errors(Error, S#eredis_sentinel_state.errors),
             Sentinels = rotate(S#eredis_sentinel_state.endpoints),
@@ -228,7 +230,8 @@ query_master(Pid, MasterGroup) ->
         Result ->
             Result
     catch Type:Error ->
-            error_logger:error_msg("Sentinel error getting master ~p : ~p:~p", [MasterGroup, Type, Error]),
+            ?LOG_ERROR("Sentinel error getting master ~p: ~p:~p",
+                       [MasterGroup, Type, Error]),
             {error, Error}
     end.
 
-- 
2.35.3

Places

File 0001-Turn-repeated-errors-into-notice-and-replace-error_l.patch of Package eredis

Places