Chore: Build Basic Logging Library

[nelsonic]

https://hex.pm/packages/logs

Todo

• Build logging library that we can use in Chore: Respect Logging Pref of Parent/Supervisor App envar#42
• Make it general purpose so we can re-use it in auth when we re-build it! Proposal: Rebuild Auth App using mix phx.gen.auth when Phoenix@1.7 Ships auth#207

# Research

Briefly looked at https://github.com/sile/logi

But the docs are in JP 🇯🇵 : https://github.com/sile/logi/blob/master/README.ja.md

And it does waaaay too much stuff. The author clearly knows what they are doing: https://github.com/sile

But right now I just want the simplest possible interface we can use and get back to our work!

[nelsonic]

https://www.genui.com/resources/elixir-learnings-structured-logging

[panoramix360]

hey! I was looking through the dwyl projects and I found logs reading through things on the imgup.

Did you guys already create a POC or something for this project?

I was curious and thinking of starting something or helping define it.

Maybe we need to define some things like:

• The different types of logs that we want to support, like error, debug, and info logs for example
• If we are going to have different severity of logs.
• If we are going to store logs in a database or just send them to other platforms like AWS, Azure, etc. Or even write to a file. Or just the console. It's nice to add support for different outputs when the time comes.
• The Python logging lib is a really nice starting point to get some ideas, together with your recommendation.

Well, let's open the chat so we can discuss some ideas if you guys are willing to do it.

I'd be excited to work on something if it reaches that point.

[ndrean]

@nelsonic Seems a good candidate https://github.com/onkel-dirtus/logger_file_backend/tree/master. You can separate :info, :debug, :warning easily.

I made a quick test by redirecting Logger.debug and Logger.info into their own files. Output example:

18:10:25.825 [debug] Replied in 42µs
18:10:25.825 [debug] HANDLE PARAMS in LiveNavWeb.HomeLive
  Parameters: %{}
18:10:25.825 [debug] Replied in 13µs
18:10:29.955 [debug] HANDLE EVENT "update_count" in LiveNavWeb.HomeLive
  Parameters: %{"value" => ""}
18:10:29.956 [debug] Elixir.LiveNavWeb.HomeLive: count: 1
18:10:29.956 [debug] Replied in 1ms
18:10:30.185 [debug] HANDLE EVENT "update_count" in LiveNavWeb.HomeLive
  Parameters: %{"value" => ""}
18:10:30.185 [debug] Elixir.LiveNavWeb.HomeLive: count: 2
18:10:30.185 [debug] Replied in 507µs

18:18:05.134 [info] Running LiveNavWeb.Endpoint with cowboy 2.10.0 at 127.0.0.1:4000 (http)
18:18:05.135 [info] Access LiveNavWeb.Endpoint at http://localhost:4000
18:18:09.231 [info] GET /
18:18:09.272 [info] Sent 200 in 40ms
18:18:09.339 [info] CONNECTED TO Phoenix.LiveView.Socket in 11µs
  Transport: :websocket
  Serializer: Phoenix.Socket.V2.JSONSerializer
  Parameters: %{"_csrf_token" => "XAVjB2w0ExklQmwDKmRBOCAACjQHKB9-hFS_XUfPN2Xln-sZZVceDRm4", "_live_referer" => "undefined", "_mounts" => "0", "_track_static" => %{"0" => "http://localhost:4000/assets/app.css", "1" => "http://localhost:4000/assets/app.js"}, "vsn" => "2.0.0"}
18:18:09.346 [info] Elixir.LiveNavWeb.HomeLive: mounted

I believe this can to S3.

This config is simple.

# Configures Elixir's Logger
config :logger, :console,
  format: "$time $metadata[$level] $message\n",
  metadata: [:request_id]

config :logger,
  backends: [{LoggerFileBackend, :error_log}, {LoggerFileBackend, :info}]

config :logger, :error_log,
  path: "./error.log",
  level: :debug

config :logger, :info,
  path: "./info.log",
  level:  : info 

def application do
    [
      mod: {LiveNav.Application, []},
      extra_applications: [:logger, :runtime_tools, :logger_file_backend]
    ]
  end