sezaru

sezaru

How to add custom metadata for errors in process

Sometimes I get some errors in my log that doesn’t have enough information to allow me to reproduce the issue.

So I was wondering how can I add custom metadata to a process so when a new error is logged, that metadata is show too.

I know that you can do something like this with Logger.metadata, but AFAIK, this only works with structured data, basically you define in the config the keys you accept as metadata and that is what I you can use in all your project.

What I want is to be able to add custom data depending on what I’m doing. For example, if I’m processing some data from a crypto market like BTC_USDT, then I would like my log to show something like market: BTC_USDT when an error is logged.

In other words, I don’t want to have to fill the metadata config with a bunch of keys for every time I want to add a new metadata in my codebase.

config :logger, :console,
 metadata: [...]

Marked As Solved

sezaru

sezaru

I think I figured it out.

What I did was add a :other field to my metadata array, then i adde a case for my custom log formatter to handle that field.

So my config became like this:

config :logger, :console,
  level: :debug,
  metadata: [:other],
  format: {Log.Formatter, :format}

And my formatter like this:

defmodule Log.Formatter do
  @moduledoc false

  alias IO.ANSI

  @color_reset ANSI.reset()
  @highlight ANSI.light_magenta()

  def format(:debug, message, timestamp, metadata),
    do: format(:debug, message, timestamp, metadata, ANSI.cyan())

  def format(:info, message, timestamp, metadata),
    do: format(:info, message, timestamp, metadata, ANSI.green())

  def format(:notice, message, timestamp, metadata),
    do: format(:notice, message, timestamp, metadata, ANSI.light_yellow())

  def format(:warn, message, timestamp, metadata),
    do: format(:warn, message, timestamp, metadata, ANSI.yellow())

  def format(:warning, message, timestamp, metadata),
    do: format(:warn, message, timestamp, metadata, ANSI.yellow())

  def format(:error, message, timestamp, metadata),
    do: format(:error, message, timestamp, metadata, ANSI.red())

  def format(:critical, message, timestamp, metadata),
    do: format(:critical, message, timestamp, metadata, ANSI.yellow_background())

  def format(:alert, message, timestamp, metadata),
    do: format(:alert, message, timestamp, metadata, ANSI.light_red_background())

  def format(:emergency, message, timestamp, metadata),
    do: format(:emergency, message, timestamp, metadata, ANSI.red_background())

  defp format(level, message, timestamp, metadata, color) do
    date_time = format_date_time(timestamp)
    metadata = format_metadata(metadata, color)

    "\n#{color}#{date_time} [#{level}] #{metadata}\n↳ #{message}#{@color_reset}\n"
  rescue
    _ -> "Could not format message: #{inspect({level, message, timestamp, metadata})}"
  end

  # This is the function I added
  defp format_metadata([{:other, value} | rest], color) do
    "#{@highlight}#{inspect(value)}#{color} " <> format_metadata(rest, color)
  end

  defp format_metadata([{_key, value} | rest], color) do
    "#{inspect(value)} " <> format_metadata(rest, color)
  end

  defp format_metadata([], _), do: ""

  defp format_date_time({date, time}) do
    alias Logger.Formatter

    "#{Formatter.format_date(date)} #{Formatter.format_time(time)}"
  end
end

That way, I can send any data to it using the other metadata,

For example, Logger.error("blibs", other: %{blibs: 2}) will be logged as:

2025-07-14 19:23:44.530 [error] #PID<0.770.0> %{blibs: 2} 
↳ blibs

Also Liked

axelson

axelson

Scenic Core Team

You can also set metadata: :all to log whatever metadata you pass.

Where Next?

Popular in Questions Top

aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New

Other popular topics Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

We're in Beta

About us Mission Statement