Sebb
Logger: build log-message as data, postpone actual logging
I’m just trying to make the functional core of my application as pure as possible, following the functional core, imperative shell pattern.
One problem I have is logging. Consider this code deep in the core:
case var do
:foo ->
{:ok, "foo"}
:bar ->
{:error, "bar"}
end
So one of the possible return values of the core would be{:error, "bar"}. This error is just data, so I can easily write a test, that’s good. But I would also like to log it. I could:
- write a handler in the shell that matches on all errors and logs them. But then I’m missing Logger’s metadata.
- I could prepend each
{:error, ...}with a call to Logger
What I’d rather do is sth like this:
- core:
{:error, {"bar", Logger.get_all_meta([custom_meta: :my_metadata])}} - shell: use this data to log at one place outside the core with correct metadata
Marked As Solved
Sebb
there is a bug in the last version, it can’t handle complex data, this should be better, but most likely is still flawed.
# with log level :info
import PureLogger
assert [{:logger, :error, {4711, %{file: _, line: _}}}] = error(4711)
assert [{:logger, :error, {'test', %{file: _, line: _}}}] = error('test')
assert [{:logger, :error, {"test", %{file: _, line: _}}}] = error("test")
assert [{:logger, :error, {[1, 2, 3], %{file: _, line: _}}}] = error([1, 2, 3])
assert [{:logger, :error, {[a: 1, b: 2], %{file: _, line: _}}}] = error([a: 1, b: 2])
assert [{:logger, :error, {{1, 2}, %{file: _, line: _}}}] = error({1, 2})
assert [{:logger, :error, {{1, 2, 3}, %{file: _, line: _}}}] = error({1, 2, 3})
assert [{:logger, :error, {%{a: 1}, %{}}}] = error(%{a: 1, b: 2, c: 3})
assert [] = debug(%{a: 1, b: 2, c: 3})
defmodule PureLogger do
@levels [:emergency, :alert, :critical, :error, :warning, :notice, :info, :debug]
for level <- @levels do
defmacro unquote(level)(data) do
maybe_log(unquote(level), data, __CALLER__)
end
end
def maybe_log(level, data, caller) do
meta = Map.take(caller, [:file, :line])
if do_log?(level) do
quote do
[
{
:logger,
unquote(level),
{
unquote(data),
unquote(Macro.escape(meta))
}
}
]
end
else
[]
end
end
defp do_log?(level) do
min_level = Application.get_env(:toy, :log_min_level, :all)
:logger.compare_levels(level, min_level) == :gt
end
end
Also Liked
hauleth
Ok, now I can write about it.
To be able to listen to the data for given process, then you need to instantiate your own handler. Simplest approach to that would be:
defmodule CaptureStructuredLogs do
def capture_log(callback) do
this = self()
handler_id = :"handler_#{inspect(this)}"
:ok = :logger.add_handler(handler_id, __MODULE__, %{config: %{pid: this}})
try do
callback.()
after
:logger.remove_handler(handler_id)
end
fetch_all_messages([])
end
defp fetch_all_messages(messages) do
receive do
{{__MODULE__, :log}, log_event} ->
fetch_all_messages([log_event | messages])
after
0 -> Enum.reverse(messages)
end
end
def adding_handler(%{config: %{pid: pid}} = config) when is_pid(pid), do: {:ok, config}
def adding_handler(_), do: {:error, :required_pid}
def log(log_event, %{config: %{pid: pid}}) do
send(pid, {{__MODULE__, :log}, log_event)
end
end
Now you can use it like “old” function:
test "capture log" do
import CaptureStructuredLogs
require Logger
assert [%{msg: {:report, %{key: "value"}}}] = capture_log(fn -> Logger.error(%{key: "value"}) end)
end
hauleth
I would just slap logging in place. While this mean that there is a little of “impurity” in “core” that doesn’t really matter, as that “impurity” do not affect the overall system. So unless there are other considerations that you do not listed in your post, then I would just do not care about it.
However if you want to have it just in case when you need debugging, then you probably would prefer setup dynamic tracing on that function.
Ljzn
If you just want to test logging, can use CaptureLog:
test "capture error log" do
import ExUnit.CaptureLog
require Logger
assert capture_log(fn -> Logger.error("?") end) =~ "?"
end
sasajuric
If I understand correctly, you want to log the file/line where the error is produced? I typically don’t obsess about that, but instead aim to make different branches return different errors, which means that I can deduce the source of the error from its content.
However, if I really wanted to preserve the stack trace I’d probably log in place, as @hauleth said.
But, if you want to stick to pure functional for fun & sport, you could use __ENV__ to include file & line in the returned error, and then include that info in the logged message.
hauleth
Because of the backward compatibility. I can check out if that could be “fixed” by adding new module to ExUnit though. I will try to provide PR tomorrow (CET) unless you will do that first. You can ping me in PR if you want.







