Skip to content
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

Preserve logger reports through translation by encapculating translated output in report_cb #14380

Merged
merged 2 commits into from
Apr 1, 2025
+83 −54
Merged

Preserve logger reports through translation by encapculating translated output in report_cb #14380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30944d4
Preserve logger reports through translation by encapculating translated
martosaur Mar 29, 2025
2159b52
Do not use anonymous function as a callback
martosaur Mar 30, 2025
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
25 changes: 23 additions & 2 deletions lib/logger/lib/logger/utils.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,32 @@ defmodule Logger.Utils do
else
:none -> :ignore
:skip -> :stop
{:ok, chardata} -> %{event | msg: {:string, chardata}}
{:ok, char, meta} -> %{event | msg: {:string, char}, meta: Enum.into(meta, event.meta)}
{:ok, chardata} -> return_translated_event(event, chardata)
{:ok, char, meta} -> return_translated_event(event, char, meta)
end
end

def translated_cb(report) do
{~c"~ts", [report[:elixir_translation]]}
end

defp return_translated_event(event, translated, meta \\ [])

defp return_translated_event(%{msg: {:report, report}} = event, translated, meta) do
report = Enum.into([elixir_translation: translated], report)
meta = Enum.into(meta, event.meta)

%{
event
| msg: {:report, report},
meta: Enum.into([report_cb: &__MODULE__.translated_cb/1], meta)
}
end

defp return_translated_event(event, translated, meta) do
%{event | msg: {:string, translated}, meta: Enum.into(meta, event.meta)}
end

defp translate([{mod, fun} | t], min_level, level, kind, data) do
with :none <- apply(mod, fun, [min_level, level, kind, data]) do
translate(t, min_level, level, kind, data)
Expand Down
112 changes: 60 additions & 52 deletions lib/logger/test/logger/translator_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ defmodule Logger.TranslatorTest do
** (RuntimeError) oops
"""

assert_receive {:event, {:string, ["GenServer " <> _ | _]}, gen_server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, gen_server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = gen_server_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand All @@ -200,8 +200,8 @@ defmodule Logger.TranslatorTest do
{:ok, pid} = GenServer.start(MyGenServer, :ok, name: config.test)
capture_log(:info, fn -> catch_exit(GenServer.call(pid, :error)) end)

assert_receive {:event, {:string, ["GenServer " <> _ | _]}, gen_server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, gen_server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert gen_server_metadata[:registered_name] == config.test
assert process_metadata[:registered_name] == config.test
Expand All @@ -211,8 +211,8 @@ defmodule Logger.TranslatorTest do
{:ok, pid} = GenServer.start(MyGenServer, :ok, name: {:global, config.test})
capture_log(:info, fn -> catch_exit(GenServer.call(pid, :error)) end)

assert_receive {:event, {:string, ["GenServer " <> _ | _]}, gen_server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, gen_server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert gen_server_metadata[:registered_name] == config.test
refute Map.has_key?(process_metadata, :registered_name)
Expand Down Expand Up @@ -260,8 +260,8 @@ defmodule Logger.TranslatorTest do
.*
"""s

assert_receive {:event, {:string, [["GenServer " <> _ | _] | _]}, gen_server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, gen_server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = gen_server_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand Down Expand Up @@ -330,8 +330,8 @@ defmodule Logger.TranslatorTest do
assert_receive {:DOWN, ^mon, _, _, _}
end) =~ "Client"

assert_receive {:event, {:string, [["GenServer " <> _ | _] | _]}, _gen_server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, _process_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, _gen_server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, _process_metadata}
end

test "translates :gen_event crashes" do
Expand All @@ -346,7 +346,7 @@ defmodule Logger.TranslatorTest do
** (RuntimeError) oops
"""

assert_receive {:event, {:string, [":gen_event handler " <> _ | _]}, metadata}
assert_receive {:event, {:report, %{label: {:gen_event, :terminate}}}, metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = metadata[:crash_reason]
refute Map.has_key?(metadata, :initial_call)
refute Map.has_key?(metadata, :registered_name)
Expand All @@ -364,7 +364,7 @@ defmodule Logger.TranslatorTest do
** (RuntimeError) oops
"""

assert_receive {:event, {:string, [":gen_event handler " <> _ | _]}, metadata}
assert_receive {:event, {:report, %{label: {:gen_event, :terminate}}}, metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = metadata[:crash_reason]
assert metadata[:registered_name] == config.test
end
Expand Down Expand Up @@ -402,7 +402,7 @@ defmodule Logger.TranslatorTest do
State: :ok
"""s

assert_receive {:event, {:string, [[":gen_event handler " <> _ | _] | _]}, metadata}
assert_receive {:event, {:report, %{label: {:gen_event, :terminate}}}, metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = metadata[:crash_reason]
end

Expand All @@ -416,8 +416,8 @@ defmodule Logger.TranslatorTest do
** (RuntimeError) oops
"""

assert_receive {:event, {:string, [":gen_statem " <> _ | _]}, gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = gen_statem_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand All @@ -433,8 +433,8 @@ defmodule Logger.TranslatorTest do
{:ok, pid} = :gen_statem.start({:local, config.test}, MyGenStatem, :ok, [])
capture_log(:info, fn -> catch_exit(:gen_statem.call(pid, :error)) end)

assert_receive {:event, {:string, [":gen_statem " <> _ | _]}, gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert gen_statem_metadata[:registered_name] == config.test
assert process_metadata[:registered_name] == config.test
Expand All @@ -444,8 +444,8 @@ defmodule Logger.TranslatorTest do
{:ok, pid} = :gen_statem.start({:global, config.test}, MyGenStatem, :ok, [])
capture_log(:info, fn -> catch_exit(:gen_statem.call(pid, :error)) end)

assert_receive {:event, {:string, [":gen_statem " <> _ | _]}, gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert gen_statem_metadata[:registered_name] == config.test
refute Map.has_key?(process_metadata, :registered_name)
Expand Down Expand Up @@ -498,8 +498,8 @@ defmodule Logger.TranslatorTest do
.*
"""s

assert_receive {:event, {:string, [[":gen_statem " <> _ | _] | _]}, gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = gen_statem_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand Down Expand Up @@ -574,8 +574,8 @@ defmodule Logger.TranslatorTest do
assert_receive {:DOWN, ^mon, _, _, _}
end) =~ "Client"

assert_receive {:event, {:string, [[":gen_statem " <> _ | _] | _]}, _gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, _process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, _gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, _process_metadata}
end

test "translates :gen_statem crashes when callback_mode is :handle_event_function" do
Expand All @@ -593,8 +593,8 @@ defmodule Logger.TranslatorTest do
Callback mode: .*, state_enter: false
"""s

assert_receive {:event, {:string, [[":gen_statem " <> _ | _] | _]}, gen_statem_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:gen_statem, :terminate}}}, gen_statem_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = gen_statem_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand Down Expand Up @@ -622,7 +622,7 @@ defmodule Logger.TranslatorTest do
Args: \[#PID<\d+\.\d+\.\d+>\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = task_metadata[:crash_reason]
assert [parent] == task_metadata[:callers]
refute Map.has_key?(task_metadata, :initial_call)
Expand All @@ -643,7 +643,7 @@ defmodule Logger.TranslatorTest do
Args: \[\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert [parent] == task_metadata[:callers]
assert {%UndefinedFunctionError{function: :undef}, [_ | _]} = task_metadata[:crash_reason]
end
Expand All @@ -663,7 +663,7 @@ defmodule Logger.TranslatorTest do
Args: \[\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert [parent] == task_metadata[:callers]
assert {%UndefinedFunctionError{function: :undef}, [_ | _]} = task_metadata[:crash_reason]
end
Expand Down Expand Up @@ -691,7 +691,7 @@ defmodule Logger.TranslatorTest do
Args: \[%ErlangError{.*}\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert [parent] == task_metadata[:callers]
assert {%ErlangError{original: :foo}, [_ | _]} = task_metadata[:crash_reason]
end
Expand All @@ -711,7 +711,7 @@ defmodule Logger.TranslatorTest do
Args: \[:badarg\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert [parent] == task_metadata[:callers]
assert {%ArgumentError{message: "argument error"}, [_ | _]} = task_metadata[:crash_reason]
end
Expand All @@ -731,7 +731,7 @@ defmodule Logger.TranslatorTest do
Args: \[:abnormal\]
"""s

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert [parent] == task_metadata[:callers]
assert {:abnormal, [_ | _]} = task_metadata[:crash_reason]
end
Expand Down Expand Up @@ -813,7 +813,7 @@ defmodule Logger.TranslatorTest do
Ancestors: \[#PID<\d+\.\d+\.\d+>\]
"""s

assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert is_pid(process_metadata[:pid])
assert is_list(process_metadata[:ancestors])
Expand Down Expand Up @@ -857,7 +857,7 @@ defmodule Logger.TranslatorTest do
Ancestors: \[#PID<\d+\.\d+\.\d+>\]
"""s

assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
end

Expand All @@ -884,7 +884,7 @@ defmodule Logger.TranslatorTest do
Ancestors: \[#PID<\d+\.\d+\.\d+>\]
"""s

assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
end

Expand All @@ -908,7 +908,7 @@ defmodule Logger.TranslatorTest do
Ancestors: \[#PID<\d+\.\d+\.\d+>\]
"""s

assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
end

Expand Down Expand Up @@ -1051,7 +1051,7 @@ defmodule Logger.TranslatorTest do
Start Call: Logger.TranslatorTest.undef\(\)
"""s

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :start_error}}}, _child_metadata}
end

test "translates Supervisor reports terminated" do
Expand All @@ -1068,9 +1068,12 @@ defmodule Logger.TranslatorTest do
Start Call: Task.start_link\(Kernel, :exit, \[:stop\]\)
"""

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:string, ["Child ", "Task" | _]}, _child_task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown}}}, _child_metadata}

assert_receive {:event, {:report, %{label: {:supervisor, :child_terminated}}},
_child_task_metadata}

assert {:stop, [_ | _]} = task_metadata[:crash_reason]
end

Expand All @@ -1087,9 +1090,12 @@ defmodule Logger.TranslatorTest do
Start Call: Task.start_link\(Kernel, :exit, \[:stop\]\)
"""

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:string, ["Child ", "Task" | _]}, _child_task_metadata}
assert_receive {:event, {:report, %{label: {Task.Supervisor, :terminating}}}, task_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown}}}, _child_metadata}

assert_receive {:event, {:report, %{label: {:supervisor, :child_terminated}}},
_child_task_metadata}

assert {:stop, [_ | _]} = task_metadata[:crash_reason]
end

Expand All @@ -1105,7 +1111,7 @@ defmodule Logger.TranslatorTest do
Start Call: Logger.TranslatorTest.abnormal\(\)
"""

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown_error}}}, _child_metadata}
end

test "translates Supervisor reports abnormal shutdown on debug" do
Expand All @@ -1125,7 +1131,7 @@ defmodule Logger.TranslatorTest do
Type: :worker
"""

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown_error}}}, _child_metadata}
end

test "translates DynamicSupervisor reports abnormal shutdown" do
Expand All @@ -1144,7 +1150,7 @@ defmodule Logger.TranslatorTest do
Start Call: Logger.TranslatorTest.abnormal\(\)
"""

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown_error}}}, _child_metadata}
end

test "translates DynamicSupervisor reports abnormal shutdown including extra_arguments" do
Expand All @@ -1165,7 +1171,7 @@ defmodule Logger.TranslatorTest do
Start Call: Logger.TranslatorTest.abnormal\(:extra, :args\)
"""

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown_error}}}, _child_metadata}
end

test "translates named DynamicSupervisor reports abnormal shutdown" do
Expand All @@ -1184,7 +1190,7 @@ defmodule Logger.TranslatorTest do
Start Call: Logger.TranslatorTest.abnormal\(\)
"""

assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:supervisor, :shutdown_error}}}, _child_metadata}
end

test "translates :supervisor_bridge progress" do
Expand Down Expand Up @@ -1213,8 +1219,8 @@ defmodule Logger.TranslatorTest do
Start Module: Logger.TranslatorTest.MyBridge
"""

assert_receive {:event, {:string, ["Task " <> _ | _]}, task_metadata}
assert_receive {:event, {:string, ["Child of Supervisor " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, task_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, _child_metadata}
assert {:stop, [_ | _]} = task_metadata[:crash_reason]
end

Expand Down Expand Up @@ -1252,9 +1258,11 @@ defmodule Logger.TranslatorTest do
end)

assert log =~ ~s(Start Call: Logger.TranslatorTest.WeirdFunctionNamesGenServer."start link"/?)
assert_receive {:event, {:string, ["GenServer " <> _ | _]}, server_metadata}
assert_receive {:event, {:string, ["Process " | _]}, process_metadata}
assert_receive {:event, {:string, ["Child " | _]}, _child_metadata}
assert_receive {:event, {:report, %{label: {:gen_server, :terminate}}}, server_metadata}
assert_receive {:event, {:report, %{label: {:proc_lib, :crash}}}, process_metadata}

assert_receive {:event, {:report, %{label: {:supervisor, :child_terminated}}},
_child_metadata}

assert {%RuntimeError{message: "oops"}, [_ | _]} = server_metadata[:crash_reason]
assert {%RuntimeError{message: "oops"}, [_ | _]} = process_metadata[:crash_reason]
Expand Down
Loading