Skip to content

fix: improve log message to indicate detailed reason of request drop #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zmstone merged 1 commit into from
Dec 13, 2025
Merged

fix: improve log message to indicate detailed reason of request drop #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
* 4.1.4
- Optimize log message `replayq_overflow_dropped_produce_calls`.
Changed to `dropped_produce_requests` with a descriptive `cause` to hint detailed reason: `buffer_size_limit` or `high_system_RAM_usage`.

* 4.1.3
- Ensure `wolff_client_sup:ensure_absence` and `wolff_producers_sup:ensure_absence` will perform shutdown and cleanup atomically.
Previously, if the caller process is killed while waiting for shutdown, a terminated child may leak under the supervisor.
Expand Down
38 changes: 24 additions & 14 deletions src/wolff_producer.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@
-define(EMPTY, empty).
-define(SYNC_REF(Caller, Ref), {Caller, Ref}).
-define(IS_SYNC_REF(Caller, Ref), ((is_reference(Caller) orelse is_pid(Caller)) andalso is_reference(Ref))).
-define(DISCARD_OVERFLOW, "buffer_size_limit").
-define(DISCARD_HIGH_MEM, "high_system_RAM_usage").

-type ack_fun() :: wolff:ack_fun().
-type send_req() :: ?SEND_REQ({pid(), reference()}, [wolff:msg()], ack_fun()).
Expand Down Expand Up @@ -1004,7 +1006,7 @@ eval_ack_cb(?ACK_CB({Caller, Ref}, Partition), BaseOffset) when ?IS_SYNC_REF(Cal
ok.

handle_overflow(St, _IsHighMemOverflow, Overflow) when Overflow =< 0 ->
ok = maybe_log_discard(St, 0),
ok = maybe_log_discard(St, 0, ?DISCARD_OVERFLOW),
St;
handle_overflow(#{replayq := Q,
pending_acks := PendingAcks,
Expand All @@ -1013,10 +1015,17 @@ handle_overflow(#{replayq := Q,
IsHighMemOverflow,
Overflow) ->
BytesMode =
case IsHighMemOverflow of
true -> at_least;
false -> at_most
end,
case IsHighMemOverflow of
true -> at_least;
false -> at_most
end,
OverflowReason =
case IsHighMemOverflow of
true ->
?DISCARD_HIGH_MEM;
false ->
?DISCARD_OVERFLOW
end,
{NewQ, QAckRef, Items} =
replayq:pop(Q, #{bytes_limit => {BytesMode, Overflow}, count_limit => 999999999}),
ok = replayq:ack(NewQ, QAckRef),
Expand All @@ -1027,7 +1036,7 @@ handle_overflow(#{replayq := Q,
wolff_metrics:dropped_inc(Config, NrOfCalls),
wolff_metrics:queuing_set(Config, replayq:count(NewQ)),
wolff_metrics:queuing_bytes_set(Config, replayq:bytes(NewQ)),
ok = maybe_log_discard(St, NrOfCalls),
ok = maybe_log_discard(St, NrOfCalls, OverflowReason),
{CbList, NewPendingAcks} = wolff_pendack:drop_backlog(PendingAcks, CallIDs),
lists:foreach(fun(Cb) -> eval_ack_cb(Cb, ?buffer_overflow_discarded) end, CbList),
St#{replayq := NewQ, pending_acks := NewPendingAcks}.
Expand All @@ -1049,27 +1058,28 @@ reply_error_for_all_reqs(St, Reason) ->
inc_sent_failed(Config, Count - AlreadyInc, 1).

%% use process dictionary for upgrade without restart
maybe_log_discard(St, Increment) ->
maybe_log_discard(St, Increment, Reason) ->
Last = get_overflow_log_state(),
#{last_cnt := LastCnt, acc_cnt := AccCnt} = Last,
case LastCnt =:= AccCnt andalso Increment =:= 0 of
true -> %% no change
ok;
false ->
maybe_log_discard(St, Increment, Last)
maybe_log_discard(St, Increment, Last, Reason)
end.

maybe_log_discard(#{topic := Topic, partition := Partition},
Increment,
#{last_ts := LastTs, last_cnt := LastCnt, acc_cnt := AccCnt}) ->
#{last_ts := LastTs, last_cnt := LastCnt, acc_cnt := AccCnt},
Reason) ->
NowTs = now_ts(),
NewAccCnt = AccCnt + Increment,
DiffCnt = NewAccCnt - LastCnt,
case NowTs - LastTs > ?MIN_DISCARD_LOG_INTERVAL of
true ->
log_warn(Topic, Partition,
"replayq_overflow_dropped_produce_calls",
#{count => DiffCnt}),
"dropped_produce_requests",
#{count => DiffCnt, cause => Reason}),
put_overflow_log_state(NowTs, NewAccCnt, NewAccCnt);
false ->
put_overflow_log_state(LastTs, LastCnt, NewAccCnt)
Expand Down Expand Up @@ -1166,12 +1176,12 @@ set_process_label(_ClientId, _Topic, _Partition) ->
-include_lib("eunit/include/eunit.hrl").

maybe_log_discard_test_() ->
[ {"no-increment", fun() -> maybe_log_discard(undefined, 0) end}
[ {"no-increment", fun() -> maybe_log_discard(undefined, 0, ?DISCARD_OVERFLOW) end}
, {"fake-last-old",
fun() ->
Ts0 = now_ts() - ?MIN_DISCARD_LOG_INTERVAL - 1,
ok = put_overflow_log_state(Ts0, 2, 2),
ok = maybe_log_discard(#{topic => <<"a">>, partition => 0}, 1),
ok = maybe_log_discard(#{topic => <<"a">>, partition => 0}, 1, ?DISCARD_OVERFLOW),
St = get_overflow_log_state(),
?assertMatch(#{last_cnt := 3, acc_cnt := 3}, St),
?assert(maps:get(last_ts, St) - Ts0 > ?MIN_DISCARD_LOG_INTERVAL)
Expand All @@ -1180,7 +1190,7 @@ maybe_log_discard_test_() ->
fun() ->
Ts0 = now_ts(),
ok = put_overflow_log_state(Ts0, 2, 2),
ok = maybe_log_discard(#{topic => <<"a">>, partition => 0}, 2),
ok = maybe_log_discard(#{topic => <<"a">>, partition => 0}, 2, ?DISCARD_OVERFLOW),
St = get_overflow_log_state(),
?assertMatch(#{last_cnt := 2, acc_cnt := 4}, St),
?assert(maps:get(last_ts, St) - Ts0 < ?MIN_DISCARD_LOG_INTERVAL)
Expand Down